Query message status and charge
Overview
This command returns the status and charge of a message. You can query the status with the apimsgid. The API Message ID (apimsgid) is the message ID returned by the gateway when a message has been successfully submitted.
Messages can be queried up to six days after it was sent – after this time this command may not be able to find the message.
Note: Clickatell can also send message status updates to your application via means of a Callback URL. This is the recommended method to obtain message status updates as your application is not required to continually poll the Clickatell gateway. Detailed information can be found on the Callback page.
Command
getmsgcharge |
Parameters
Parameter |
Description |
---|---|
apimsgid |
This is the API message ID you get back when you send a message. |
Examples
Request data sample
1 |
|
Code samples
PHP
1 |
|
API responses
Example response
Successful API response:
1 |
|
Error response:
1 |
|
Return format
Successful API response:
apiMsgId: <message ID> charge: <charge> status: <status ID> |
Error response:
ERR: <error code>, <error description> |
Submit a Comment
Other Resources
Ask the Community
Visit Stack Overflow to join our community of developers and find the answer you need
Contact Support
Contact our support team and one of our agents will be in touch with you to answer any questions you have