Cancel the scheduled SMS
DELETE https://sms.8x8.com/api/v1/subaccounts/:subAccountId/messages/:umid
This resource can be used to cancel a scheduled message that has not been sent yet using the unique message identifier (UMID) of the message.
URL
You need to specify the sub-account id and the umid of the message in place of {subAccountId} and {umid} respectively.
umid is the unique identifier you received when you submitted the message to the API.
Request
Path Parameters
Possible values: >= 3 characters and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\-._&]{3,50}$
You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you signed up with a new account at https://connect.8x8.com.
Unique message Id, generated by 8x8 API.
Successful operation
Schema
Number of cancelled messages
{
"cancelledCount":0
}
{
"cancelledCount":1
}
This error response is returned if the request is invalid (e.g. umid is not a valid uuid).
Schema
Error code.
1000
Error message.
Invalid umid.
Unique error id auto-generated per request.
fbb239f1-2eb1-ea11-afa9-00155db6eaf4
Date and time of the error event.
2020-06-18T06:42:57.20Z
{
"code":1000,
"message":"Invalid umid.",
"errorId":"fbb239f1-2eb1-ea11-afa9-00155db6eaf4",
"timestamp":"2020-06-18T06:42:57.20Z"
}
{
"code":1000,
"message":"Invalid umid.",
"errorId":"fbb239f1-2eb1-ea11-afa9-00155db6eaf4",
"timestamp":"2020-06-18T06:42:57.20Z"
}
Request was not authenticated response
Schema
Error code
Error description
Unique id of error. You can use it as reference when sending enquiries to 8x8 support
Data and time of the error occurence
{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":1200,
"message":"Request was not authenticated properly",
"errorId":"db9dced4-3534-4d86-9d18-6b448af0d621",
"timestamp":"2018-08-02T09:42:38.8988997+00:00"
}
This error response is returned if there is a message by the specified sub account and umid does not exist.
Schema
Error code.
1300
Descriptive error message.
Message not found.
Unique error id auto-generated per request.
1949a467-2db1-ea11-afa9-00155db6eaf4
Date and time of the error event.
2020-06-18T06:31:58.11Z
{
"code":1300,
"message":"Message not found.",
"errorId":"1949a467-2db1-ea11-afa9-00155db6eaf4",
"timestamp":"2020-06-18T06:31:58.11Z"
}
{
"code":1300,
"message":"Message not found.",
"errorId":"1949a467-2db1-ea11-afa9-00155db6eaf4",
"timestamp":"2020-06-18T06:31:58.11Z"
}
Upgrade Required — client is using an unsupported TLS version
Response Headers
TLS/1.3
Schema
Error code
Error description
Unique id of error. You can use it as reference when sending enquiries to 8x8 support
Data and time of the error occurence
{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":1014,
"message":"TLS 1.3+ is required for Singapore-bound messages. Detected: TLSv1.2",
"errorId":"b4478860-b76c-e811-814e-022a35cc1c71",
"timestamp":"2018-08-04T09:25:40.9235752+00:00"
}
Source: https://developer.8x8.com/connect/reference/cancel-scheduled-message · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments