readSMSKeywords
The readSMSKeywords function attempts to return keywords that match all of the given filters.
Results
The readSMSKeywords function may return 1 or many
smsKeyword objects. See the documentation on the
smsKeywordObject for a list of the data fields that could potentially be
returned.
Note: The data fields returned depend on the type of data you ask for in your request.
Syntax
smsKeywordObject[] keywords = bApi.readSMSKeywords( filter smsKeywordFilter, includeDeleted, pageNumber);Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
smsKeywordFilter | Yes | The filter used to return a specific SMS keyword. |
includeDeleted |
boolean | No | If set to true, SMS keywords marked as deleted will be returned. When you delete an SMS keyword, it is marked for deletion and then deleted 7 days later. |
pageNumber |
int | Yes | Retrieves the next “batch” of objects as the value specified increases from 1. In order to obtain an entire set of objects for a given call, you should increase the number value assigned to pageNumber until no more objects are returned. |