Get SMS status
GET {{baseUrl}}/mra/v1/outbound/sms/status/?job_id=xsi-1234567
Once SMS request has been successfully accepted and a job ID is returned, this method allows users to request the information about the job as it is being processed by the OpenText messaging service.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
job_id | string | (Required) A string consists of xdn-mrn.Where xdn is domain name and mrn is job number. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-MRA-SubmitId | string | A client-supplied string to identify request. | |
Accept | string |
RESPONSES
status: OK
{"job_id":"xsi-1234567","job_state":["Complete","Posted"],"billing_code_base64":"dGVtcF9iaWxsX2NvZGU=","customer_reference_base64":"bXJhX2N1c3RfcmVm","entry_time":"2020-04-21T10:50:51.000Z","deliveries":[{"ref_base64":"RkFYT1VU","sms":"1234567891","delivery_attempts":[{"state":"Error","gamma_code":5000,"first_attempt":"1999-07-16T11:56:27.019Z"},{"state":"Cancelled","gamma_code":5000,"first_attempt":"1966-03-23T16:44:46.155Z"}],"events":{"sms_delivery_events":[{"event_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"status":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"event_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"status":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}},{"ref_base64":"RkFYT1VU","sms":"1234567891","delivery_attempts":[{"state":"Submitted","gamma_code":5000,"first_attempt":"1987-01-26T07:28:29.730Z"},{"state":"Sent","gamma_code":5000,"first_attempt":"1968-05-17T15:40:31.616Z"}],"events":{"sms_delivery_events":[{"event_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"status":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"event_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"status":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"message":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}}]}