View number of scheduled messages
This action retrieves the total number of scheduled messages that a user has.
HTTP request
Parameters
The following table lists the parameters that this action supports.
Parameters
Required | Type | Description |
---|---|---|
sender_id | string | Specifies the user ID of the sender. |
Optional | Type | Description |
---|---|---|
channel_type | string | Specifies the type of the channel. Acceptable values are |
channel_url | string | Specifies the URL of the target channel. |
status[] | array of strings | Specifies the scheduled message status to retrieve. If not specified, all scheduled messages are returned, regardless of their status. |
message_type | string | Specifies a message type to retrieve. Acceptable values are |
Response
If successful, this action returns a list of scheduled messages resource in the response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.