Skip to main content
PATCH
/
sip
/
sip2
Update SIP integration configuration
curl --request PATCH \
  --url https://api.cleartalk.ai/sip/sip2 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "trunkName": "Head Office",
  "phone_number": "+15550000000",
  "directions": [
    {
      "type": "outbound",
      "headers": {
        "direction": "outbound",
        "headers": [
          {
            "type": "custom",
            "key": "X-Customer-ID",
            "value": "12345",
            "passthrough": true,
            "target": "<string>",
            "purpose": "<string>",
            "encoding": "<string>",
            "content": "<string>"
          }
        ]
      },
      "sip_endpoint": "sip:192.168.1.100",
      "options": {
        "port": 5060,
        "transport": "udp",
        "secure_media": false,
        "sip_username": "<string>",
        "sip_password": "<string>"
      }
    }
  ],
  "uuid_config_id": "550e8400-e29b-41d4-a716-446655440000"
}
'

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Body

application/json
​
trunkName
string
required

Internal name to identify the Trunk

Example:

"Head Office"

​
phone_number
string
required

Phone number assigned by cleartalk AI

Example:

"+15550000000"

​
directions
object[]
required
​
uuid_config_id
string

UUID of the configuration sip local

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

SIP configuration updated successfully