Skip to content

Unschedule a message

post
https://api.reach.talkylabs.com/rest/messaging/v1/unschedule

This operation allows to cancel a previously scheduled message.

This operation needs the messageId of the message to be unscheduled. To unschedule multiple messages, this operation should be called as many times needed since it can only unschedule one message at a time.

Note: The system will make the best attempt to cancel a scheduled message when a request is received.

Parameters

  • messageIdstringrequired

    The identifier of the message to be unscheduled.

Example 1: Unschedule a previously scheduled message

curl -X POST https://api.reach.talkylabs.com/rest/messaging/v1/unschedule --data-urlencode "messageId=MIDXXXXXXXXXXXXXX" -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "appletId": "AIDXXXXXXXXXXXX",
  "apiVersion": "1.0.0",
  "body": "Hello World! This is a sms message.",
  "dest": "+237671234567",
  "src": "+237691234567",
  "numSegments": 1,
  "numMedia": 0,
  "price": null,
  "priceUnit": "xaf",
  "messageId": null,
  "status": "canceled",
  "messageType": "outbound",
  "errorCode": null,
  "errorMessage": null,
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateSent": null,
  "dateUpdated": "2016-08-29T09:12:37.001Z"
}