For the complete documentation index, see llms.txt. This page is also available as Markdown.

Status queries

Use GetStateBasic to check delivery state and read the job response.

GetStateBasic

Use this method to query the status of a sent message.

To use it, send the original message with a JobID.

Required: AccountName, AccountPassword, JobID

Optional: Address

For jobs sent to multiple recipients, specify Address. Use international format with leading zeros and no spaces, for example 0041791234567.

If you omit Address, the response returns the last job within the JobID.

Response structure

ServiceResponse
├── ResponseCode     Response code per response table (0 = OK)
└── ResponseText     Response text per response table

JobResponse          (only populated when ResponseCode = 0)
├── JobID            JobID of the sent message
├── Address          Recipient number
├── JobType          Job type
├── SendState        Send status
├── ErrorState       Error status for fax. For other types, use SendState.
├── PointsUsed       Number of credits consumed
└── FinishDate       Date and time when the job was completed

If ResponseCode is not 0, JobResponse is empty.

Standard webservice response

All web methods return this structure:

Parameter
Description

ResponseCode

0 means the job was accepted. Any other value means an error occurred.

ResponseText

Description of the response code

HTTP headers

Client request ID

Set this request header to correlate responses with your own request IDs:

Maximum length: 100 characters.

If you send it, the service echoes the same value in the response.

Server request ID

Every response includes this header:

Provide this ID to support together with the request time, account name, and operation type.

Last updated

Was this helpful?