Endpoint overview

Every operation below is the same HTTP call:

http

POST https://my.textme.co.il/api
Authorization: Bearer {api_token}
Content-Type: application/json      (or application/xml)

What changes is the root element of the body. <sms> sends a message, <dlr> pulls delivery reports, <newCL> creates a contact list. This page maps every root element to the page that documents it.

Swap the URL for https://my.textme.co.il/api/test to validate a payload without performing the action — see Request format.

API tokens

Root element	Operation
`getApiToken`	Mint a new token, or read back the most recent one. Requires an existing valid token.

Send SMS

Root element	Operation
`sms`	Send one message to any number of destinations and contact lists. Scheduling, opt-out footers, short links, recency filtering and campaign naming all live here.

Bulk send

Root element	Operation
`bulk`	Send up to 2,500 different messages in one call, each with its own text, sender and destinations.

Voice (TTS)

Root element	Operation
`sms` + `tts`	The `sms` operation with a `tts` block attached: the message is spoken down the line instead of, or as well as, being texted.

Balance

Root element	Operation
`balance`	Remaining SMS credit, international credit, or mail credit.

Reports

Root element	Operation
`dlr`	Delivery reports for external ids you supplied when sending. Up to 1,000 ids, one week per request.
`dlrByDate`	Delivery reports for a time window, without needing external ids. One week per request.
`incoming`	Messages sent to your numbers. One week per request, up to a year back.

Blocklist

Root element	Operation
`blacklist`	List numbers blocked during a date range.
`addNumBL`	Block numbers. Answers `946` on success, not `0`.
`rmNumBL`	Unblock numbers. Requires a `reason`. Answers `944` on partial success.

Contact lists

Root element	Operation
`newCL`	Create one or more lists, optionally populated, with up to six dynamic fields per contact.
`removeCL`	Delete lists by id.
`addNumCL`	Add numbers to existing lists.
`rmNumCL`	Remove numbers from existing lists.
`getCL`	Every list and its members, including empty lists.
`getCLbyID`	The members of one list.

Campaigns

Root element	Operation
`cancel`	Cancel a scheduled campaign by `campaign_id`, or every campaign matching a `campaign_name`.
`get_birthday_campaigns`	List the account's birthday campaigns.
`edit_birthday_campaign`	Replace the message body on a birthday campaign.

Verified senders

Root element	Operation
`verify_phone`	Submit numbers to become usable as a `source`.
`getVerifiedPhones`	List the numbers already verified, optionally including sub-accounts'.

Subscribers

Reseller operations, for accounts that manage sub-accounts.

Root element	Operation
`addSub`	Create a sub-account with a starting credit balance.
`updateAmountSub`	Move credit into a sub-account's wallet.
`getBlanceSubs`	Every sub-account's balance.

Push API

Not something you call — something TextMe calls. Delivery reports, incoming messages and opt-outs are POSTed to a URL you register, form-encoded.

Shared response shape

Every operation answers with status and message, then its own data. status 0 means the call was accepted; see Status codes for everything else, and note the two blocklist operations that succeed with a non-zero status.

Batch operations may also return an errors array beside a successful status — the call worked, individual rows did not. See Partial success.

Endpoint overview ​

Shared response shape ​

Endpoint overview

Shared response shape