Sign in

v1

latestSwagger 2.02026-08-06114161439.7 KB
sms

Returns SMS conversations based on the given filter criteria

Retrieves SMS conversation threads including message history between tracking numbers and contacts. Returns conversations with message content, timestamps, participant information, and delivery status. Supports pagination and filtering.

get/sms

Query parameters

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

offsetinteger

Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination.

filterstring[]

URL-encoded comma-separated list of filter conditions in the form '<field> <op> <value>' where op is one of =, !=, <=, >=, >, <, like (spaces required around 'like'). Example: 'call_started > 2024-01-01'. Max 10 conditions. Filterable fields vary by endpoint.

Response

SMS conversations with message history and metadata

conversation_idinteger

The unique identifier for the conversation. Type: integer (int32).

campaign_idinteger

Unique identifier for the campaign this call was attributed to. Integer.

group_idinteger

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

tracking_numberstring

Phone number the caller dialed (the tracking/DNI number). Convirza routes calls from this number through the configured call flow. String of digits.

caller_idstring

Phone number of the originating caller. String of digits, typically 10 digits for US numbers (e.g., '2025550123').

conversation_startedstring date-time

The date and time that the conversation was started. Type: string (date-time).

messagestring

SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).

conversation_statusstring

Indicates the current status of the conversation. Type: string.

pinboolean

Indicates whether the pin is required or not. Type: boolean.

agent_idinteger

The unique identifier for the agent assigned to the conversation. Type: integer (int32).

Example response

{
  "conversation_id": 4421,
  "campaign_id": 4421,
  "group_id": 4421,
  "tracking_number": "+13856254524",
  "caller_id": "+13856254524",
  "message": "this a test message",
  "agent_id": 4421
}