GET
/
v1
/
sms
/
numbers
curl --request GET \
  --url https://api.bland.ai/v1/sms/numbers \
  --header 'authorization: <authorization>'
{
  "data": [
    {
      "phone_number": "+14155552671",
      "sms_config": {
        "webhook": "https://example.com/sms-webhook",
        "request_data": { "ref": "campaign_123" },
        "time_out": 15,
        "messaging_service_sid": "MG1234567890abcdef",
        "objective": "Provide quick support to customers.",
        "tools": ["lookup", "escalate"],
        "temperature": 0.7,
        "pathway_id": "abc123",
        "pathway_version": "latest",
        "start_node_id": "entry-node"
      },
      "conversation_count": 34
    }
  ],
  "errors": null
}

Enterprise Feature - SMS is only available on Enterprise plans. Contact your Bland representative for access.

Headers

authorization
string
required

Your API key for authentication.

Response

data
array

A list of phone numbers with SMS configurations.

data[].phone_number
string

The E.164 formatted phone number assigned to the user.

data[].sms_config
object

The configuration used when handling inbound SMS messages.

data[].sms_config.webhook
string

When the agent sends a response, we’ll send the message details in a POST request to the URL you specify here, along with chat history.

data[].sms_config.request_data
object

Request data fields are available to the AI agent during the call when referenced in the associated pathway or task.

data[].sms_config.time_out
number

Maximum time to wait for a response. Default is no timeout.

data[].sms_config.messaging_service_sid
string

Twilio Messaging Service SID, if set.

data[].sms_config.objective
string

The assistant’s objective or system instruction.

data[].sms_config.tools
array

A list of tools available to the assistant.

data[].sms_config.temperature
number

The model’s temperature setting, controlling creativity.

data[].sms_config.pathway_id
string

The ID of the linked conversational pathway (if any).

data[].sms_config.pathway_version
string

The specific version of the pathway to use.

data[].sms_config.start_node_id
string

The ID of the first node to enter in the pathway.

data[].conversation_count
integer

The number of SMS conversations handled by this number.

errors
null

Always null on success.

{
  "data": [
    {
      "phone_number": "+14155552671",
      "sms_config": {
        "webhook": "https://example.com/sms-webhook",
        "request_data": { "ref": "campaign_123" },
        "time_out": 15,
        "messaging_service_sid": "MG1234567890abcdef",
        "objective": "Provide quick support to customers.",
        "tools": ["lookup", "escalate"],
        "temperature": 0.7,
        "pathway_id": "abc123",
        "pathway_version": "latest",
        "start_node_id": "entry-node"
      },
      "conversation_count": 34
    }
  ],
  "errors": null
}