The method described in this article is only intended for SME.
As a result of the request, the message delivery status with identifier will be returned. If the request is fully completed, you receive a response from the server that contains a JSON object with data on the current status of messages.
Request Endpoint
Make a GET request to this URL: https://im.edna.io/api/imOutMessage/imOutMessageId
, where imOutMessageId
in the path is the ID of the message, the status of which should be returned.
Request Format and Parameters
As a GET request, it doesn’t have a body and parameters, except the message ID that is passed as a part of the URL.
Response Format
The response body contains a JSON with the message delivery status and details.
{ "imOutMessageId":"test-001", "dlvStatus":"read", "dlvStatusAt":"2020-01-29T13:15:07.000+0000", "code":"ok" }
If the message was not delivered, the reason will be indicated:
{ "imOutMessageId": "test-001", "dlvStatus": "undelivered", "dlvStatusAt": "2021-01-15T11:41:20.000+0000", "dlvError": "not-whatsapp-user", "code": "ok" }
Response Parameters
Parameter | Type | Description |
imOutMessageId | string | Message ID |
dlvStatus | string | Message delivery status, refer to the Available status codes article for more details. |
dlvStatusAt | string | Time of recent status update. The time format is YYYY-MM-DDTHH:mm:ss.SSS+TZ (for example, 2020-01-29T13:05:07.000+0300), where date and time values are separated with “T”. “07.000” is for seconds and milliseconds. |
dlvError | string (optional) | Message delivery error, refer to the Available status codes article for more details. |
code | string | Response status code |