DOCUMENTATION

Send your first test message.

Use a test key and an illustrative recipient before enabling real telecommunications.

Full API reference and interactive request explorer →

Create a test key

A CRM Administrator creates keys in Messenger → Admin → Developer access and chooses scopes and permitted resources. Keep the key on your server.

Choose a number

GET /numbers lists permitted numbers and their capabilities.

Submit an action

POST /messages with to, fromNumberSid, body, and an Idempotency-Key. A test key never contacts Twilio.

Follow the status

Test responses return simulated test_ IDs, which cannot be read as CRM records. For live actions, GET /messages/{id} retrieves status; delivery is asynchronous.

Pilot access requires verified organisation configuration. Never expose a live API key in frontend code.

curl https://zemessenger.com/api/v1/messages \
  -H 'Authorization: Bearer ze_test_EXAMPLE' \
  -H 'Idempotency-Key: example-message-001' \
  -H 'Content-Type: application/json' \
  -d '{"to":"+447700900123","fromNumberSid":"PN_EXAMPLE","body":"Your consultation request has been received."}'
View the versioned OpenAPI contract