SMS Success Feedback
POST https://sms.8x8.com/api/v1/subaccounts/:subAccountId/messages/:umid/feedback
About SMS Feedback
Most of the time, programmatic SMS are meant to trigger a specific outcome (ex: authenticate a user via OTP). When the outcome does not happen it can have any number of user-related cause but what we seek to avoid is for SMS deliverability or latency to be the reason for failure. To avoid this, use this endpoint to transmit the outcome to 8x8 and let 8x8 monitor your SMS performance for you. It benefits you by allowing 8x8 to:
- Monitor your application QoS for any SMS-related failure happening in your workflows
- Act faster to restore the quality of service you experiment
- Prevent any further issue
- Provide more advanced analytics by displaying SMS outcome performance and latency metrics
About the API endpoint / method
- Sending a POST request on this endpoint allows to convey the outcome of an SMS to 8x8.
- Sharing that feedback with 8x8 is straightforward, your POST request only has to contain:
- The 8x8 UMID - Unique Message ID (included in the API response when sending the SMS)
- A status for the outcome
- For more accuracy and to get latency information: the timestamp of the event triggered by the SMS
URL
Complete endpoint URL:https://sms.8x8.com/api/v1/subaccounts/{subAccountId}/messages/{umid}/feedback
You must replace
{subAccountId}in the URL above with the subaccountid that you used originally to send the SMS.
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.
Body
Did the expected action of sending the message happen? Send a feedback to 8x8 by sending "success" or "failure". This field is mandatory.
Possible values: [success, failure]
The timestamp when the expected action of the message was performed
Bad request error 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":1002,
"message":"Invalid MSISDN format (not E.164 international number)",
"errorId":"b4478860-b76c-e811-814e-022a35cc1c71",
"timestamp":"2018-08-04T09:25:40.9235752+00:00"
}
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"
}
Internal server error
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":2000,
"message":"Internal server error",
"errorId":"db9dced4-3534-4d86-9d18-6b448af0d621",
"timestamp":"2018-07-02T09:42:38.8988997+00:00"
}
Source: https://developer.8x8.com/connect/reference/api-sms-feedback · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments