Skip to main content
GET
/
v1
/
sms
/
numbers
List 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",
        "restart_after_end_call": true,
        "timezone": "America/New_York",
        "citation_schema_ids": ["b0477cba-1c97-4105-8ac9-46cb8eae5cf1"],
        "disposition_ids": ["d1234567-abcd-1234-efgh-123456789012"],
        "summary_prompt": "Summarize the key points and outcome of this conversation."
      },
      "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[].sms_config.restart_after_end_call
boolean
When true, a new conversation is automatically started if the user texts after the current conversation has ended. When false, subsequent messages are stored in the ended conversation without triggering a new reply.
​
data[].sms_config.timezone
string
The timezone used for time-based variables in the conversation (e.g. "America/New_York").
​
data[].sms_config.citation_schema_ids
string[]
IDs of citation schemas configured for this number. Citations are extracted when conversations end. See Citations.
​
data[].sms_config.disposition_ids
string[]
IDs of outcomes configured for this number. Outcomes are evaluated when conversations end. See Outcomes.
​
data[].sms_config.summary_prompt
string
Custom prompt used to generate a conversation summary when the conversation ends.
​
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",
        "restart_after_end_call": true,
        "timezone": "America/New_York",
        "citation_schema_ids": ["b0477cba-1c97-4105-8ac9-46cb8eae5cf1"],
        "disposition_ids": ["d1234567-abcd-1234-efgh-123456789012"],
        "summary_prompt": "Summarize the key points and outcome of this conversation."
      },
      "conversation_count": 34
    }
  ],
  "errors": null
}