> For the complete documentation index, see [llms.txt](https://developer.ecall-messaging.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.ecall-messaging.com/api-references/https-interface/status-queries.md). # Status queries Use `Api/State` to query the current status of a specific message or a time range. ### Query a specific message Send the original job with a `JobID`. **Endpoint:** `Api/State` | Parameter | Description | | ---------- | --------------------------------------- | | `UserName` | Username | | `Password` | Password | | `JobID` | Unique identifier from the original job | **Example:** ``` /Api/State?Username=xxx&Password=yyy&JobID=1234ABCD ``` ### Query a time range **Endpoint:** `Api/State` | Parameter | Description | | ----------- | ----------------------------------------------------------- | | `UserName` | Username | | `Password` | Password | | `StartDate` | Start date and time of the original jobs in ISO 8601 format | | `EndDate` | End date and time of the original jobs in ISO 8601 format | {% hint style="info" %} Without a timezone, the interface uses the local eCall timezone. {% endhint %} {% hint style="warning" %} If the result contains more than 1000 status objects, the service returns HTTP `400 Bad Request` with eCall result code `11701`. {% endhint %} **Example:** ``` /Api/State?Username=xxx&Password=yyy&StartDate=2019-12-01T10:00:00&EndDate=2019-12-01T13:00:00 ``` ### Response structure The response is XML. Multiple statuses are wrapped in ``. ```xml
... ``` ### Status codes — SMS and pager | Status Code | Status Text | Description | | ----------- | ----------------------------------------------------- | ----------------------------------------------------- | | `-1` | Unknown | Status is unknown | | `99` | Scheduled | Scheduled message | | `0` | Transmitting | Sending in progress | | `1` | Ok | Sent successfully | | `3` | Waiting for result | Sending and waiting for status confirmation | | `8` | Ok (confirmed) | Sent successfully with delivery confirmation | | `9` | Ok (waiting for confirmation) | Sent successfully and awaiting confirmation | | `10` | Ok (not confirmed) | Sent successfully without confirmation | | `71` | Not accepted by gateway | No job accepted message from the gateway | | `1000` | Disconnected | Connection dropped | | `1001` | Timeout | Message could not be sent successfully | | `3020` | Connection refused | Remote host refused the connection | | `5111` | Text too long | Message text is too long | | `5112` | Invalid number | Invalid phone number | | `5120` | Message invalid | Destination is tone-only and does not accept messages | | `5121` | Invalid char in number | Destination number contains an invalid character | | `5155` | Too much traffic | Network congestion | | `5164` | Call system troubled | All paging zones are disrupted or overloaded | | `5502` | Syntax error | Provider returned a syntax error | | `5504` | Too many messages | Maximum message count for the address was exceeded | | `5506` | ADC invalid | Analog-to-digital converter invalid | | `5509` | Invalid number | Invalid phone number | | `5510` | Too many messages for same receiver | Too many messages to the same recipient | | `5511` | Too many messages with same content for same receiver | Duplicate high-volume content to the same recipient | | `5512` | Duplicate job id | The sender already used this `JobID` | | `5513` | Exists in the blacklist | Callback, address, or message content is blocked | | `5514` | Blocked by out-bound filter rule | Outgoing filter rules blocked the message | ### Status codes — voice | Status Code | Status Text | Description | | ----------- | -------------------- | --------------------------------------------- | | `30` | Transmitting | Voice message is being transferred | | `31` | Ok | Voice message transferred successfully | | `32` | Failed | Error while transferring the voice message | | `33` | Played | Voice message played successfully | | `34` | Played with feedback | Voice message played and a reply was received | | `35` | Invalid number | Invalid phone number | | `36` | Played with receipt | Voice message played with confirmation | | `37` | Connection timed out | No connection within the defined time period | | `38` | In progress | Recipient is being called | | `39` | Next try in 15 min | Recipient could not be reached | ### Status codes — fax | Status Code | Status Text | Description | | ----------- | ----------------------------- | -------------------------------------------------- | | `41` | Ok | Fax transmitted successfully | | `43` | Waiting | Transmission is waiting | | `44` | New job | Job was created | | `101` | Applied | Job group submitted to the gateway | | `201` | Started converting | Document conversion started | | `202` | Finished converting | Individual file converted | | `301` | Started merging | Document merge started | | `401` | Processing | Transmission started | | `402` | Finished processing job | Individual job completed | | `501` | Finished processing job group | Entire job group completed | | `5513` | Exists in the blacklist | Callback, address, or message content is blocked | | `6000` | Unknown error | Unknown error | | `6002` | Conversion error | Error while converting documents | | `6004` | No response | Aborted because there was no answer | | `6005` | Empty job | Nothing to send. No `JobID` was created | | `6006` | Line busy | Busy | | `6007` | Rejected | Rejected | | `6009` | Unknown number | Unknown number | | `6010` | Invalid number | Invalid number | | `6011` | Number changed | Number changed | | `6013` | No fax device | Remote side is not a fax machine | | `6014` | Disconnected by sender | Connection dropped by sender | | `6015` | Disconnected by receiver | Connection dropped by recipient | | `6016` | File format not supported | File format is not supported | | `6017` | File access failed | File access failed | | `6900` | Ok (not confirmed) | Fax sent, but the connection did not close cleanly | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.ecall-messaging.com/api-references/https-interface/status-queries.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.