Skip to content
SAEIv1

Numbers

View as Markdown

Your WhatsApp sending numbers and their health.

Endpoints

List your WhatsApp numbers

gethttps://api.saei.automize.sa/v1/numbers
  • Scope: numbers:read
  • Works in test mode

The numbers this workspace sends from, with their quality rating, daily limit and whether they can send right now. Use an id as from when sending.

Query parameters

  • limitintegeroptional

    How many objects to return, 1 to 100.

  • cursorstringoptional

    The next_cursor from the previous page.

Response fields200
  • object"list"required
  • dataarray<PhoneNumber>required
    Child fields (12)
    • idstringrequired
    • object"phone_number"required
    • phone_numberstringrequired
    • display_namestring | nulloptional
    • name_statusstring | nulloptional

      Whether WhatsApp approved the display name.

    • is_defaultbooleanrequired

      Sends by default when from is left out and the customer has no thread on another number.

    • quality_ratingstring | nulloptional

      WhatsApp's quality rating, green, yellow or red. Red numbers risk a lower daily limit.

    • messaging_limit_tierstring | nulloptional
    • daily_conversation_limitinteger | nulloptional

      Business-initiated conversations per 24 hours; null means unlimited or not yet known.

    • can_sendbooleanrequired
    • cannot_send_reasonstring | nulloptional
    • created_atstring | nulloptional
  • has_morebooleanrequired
  • next_cursorstring | nullrequired
Errors this can return2
Try it
curl -X GET https://api.saei.automize.sa/v1/numbers \
  -H "Authorization: Bearer $API_KEY"
Response

A page of numbers.

{
  "object": "list",
  "data": [
    {
      "id": "num_3",
      "object": "phone_number",
      "phone_number": "+966112345678",
      "display_name": "string",
      "name_status": "string",
      "is_default": false,
      "quality_rating": "string",
      "messaging_limit_tier": "TIER_1K",
      "daily_conversation_limit": 0,
      "can_send": false,
      "cannot_send_reason": "string",
      "created_at": "2026-10-01T09:30:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}

Get a number

gethttps://api.saei.automize.sa/v1/numbers/{id}
  • Scope: numbers:read
  • Works in test mode

One number and its health. When can_send is false, cannot_send_reason says why (disconnected, token needs reconnecting…); fix it in Settings → WhatsApp.

Path parameters

  • idstringrequired

    The object's id.

Response fields200
  • idstringrequired
  • object"phone_number"required
  • phone_numberstringrequired
  • display_namestring | nulloptional
  • name_statusstring | nulloptional

    Whether WhatsApp approved the display name.

  • is_defaultbooleanrequired

    Sends by default when from is left out and the customer has no thread on another number.

  • quality_ratingstring | nulloptional

    WhatsApp's quality rating, green, yellow or red. Red numbers risk a lower daily limit.

  • messaging_limit_tierstring | nulloptional
  • daily_conversation_limitinteger | nulloptional

    Business-initiated conversations per 24 hours; null means unlimited or not yet known.

  • can_sendbooleanrequired
  • cannot_send_reasonstring | nulloptional
  • created_atstring | nulloptional
Errors this can return2
Try it
curl -X GET https://api.saei.automize.sa/v1/numbers/num_3 \
  -H "Authorization: Bearer $API_KEY"
Response

The number.

{
  "id": "num_3",
  "object": "phone_number",
  "phone_number": "+966112345678",
  "display_name": "متجر النخبة",
  "name_status": "APPROVED",
  "is_default": true,
  "quality_rating": "green",
  "messaging_limit_tier": "TIER_1K",
  "daily_conversation_limit": 1000,
  "can_send": true,
  "cannot_send_reason": null,
  "created_at": "2026-06-01T10:00:00Z"
}