SIP Integration

curl -X POST https://api.bland.ai/v1/sip/attach \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+14150000000",
    "directions": [
      { 
        "type": "inbound", 
        "headers": {
          "direction": "inbound", // Must be set to the parent objects direction.
          "headers": [
            // Passthrough Off. We take the incoming SIP header's value for "X-Cool-Guy" and assign it to the pathway variable's value for "First_Name".
            { "type": "custom", "key": "X-Cool-Guy", "value": "First_Name" },
            // Passthrough On. We inject this header key value pair directly into the pathway variable state.
            { "type": "custom", "key": "Account_Type", "value": "VIP", "passthrough": true },
            // Inbound UUI Example. If an inbound UUI header with purpose=bland arrives,
            // its decoded value will be stored in the pathway variable "CustomerId".
            // For example, a wire header like:
            //   SipHeader_user-to-user: 3432;encoding=hex;purpose=bland;content=id
            // will decode hex(3432) -> "42", then assign { "CustomerId": "42" }.
            { "type": "uui", "target": "CustomerId", "purpose": "bland", "encoding": "hex", "content": "id" }
          ]
        }
      },
      { 
        "type": "outbound", 
        "sip_endpoint": "sip:your.provider.com", // FQDN Only. Port must be defined here, or in options. Prefixed with `sip:`
        "options": {
          "port": 1234, // Will overwrite any port defined in your sip_endpoint.
          "transport": "tls", // Other available: tls, tcp, udp
          "secure_media": true, // True, False
          "sip_username": "bland", // Optional
          "sip_password": "password" // Optional
        },
        "headers": {
          "direction": "outbound", // Must be set to the parent objects direction.
          "headers": [
            // Passthrough off. We bind a specific header's **value** to a pathway variable provided for (if available). So the value of "X-Favorite-Color" is assigned
            // as the value for "Favorite_Color".
            {
              "type": "custom", // "custom" or "uui" supported.
              "key": "Favorite_Color",
              "value": "X-Favorite-Color"
            },
            // Passthrough on. We directly pass the key and value as-is.
            {
              "type": "custom",
              "key": "x-custom-id",
              "value": "12345",
              "passthrough": true
            },
            // Outbound UUI Example. If the pathway variable "CustomerKV" has a value,
            // it will be hex-encoded and sent in a UUI header with purpose=bland and content=customerid_1234.
            // For example, { "CustomerKV": "id=12345" } becomes:
            //   SipHeader_user-to-user: 69643d3132333435;encoding=hex;purpose=bland;content=customerid_1234
            {
              "type": "uui",
              "target": "CustomerKV", // Variable to look up in pathway state.
              "purpose": "bland",     // Outbound purpose field in the UUI header.
              "content": "customerid_1234", // Used as the "content" parameter in the UUI header.
              "encoding": "hex"       // Supported: "hex", "ascii"
            }
          ]
        }
      }
    ],
    "service": "sip"
  }'

curl -X PUT https://api.bland.ai/v1/sip/verify \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+14150000000",
  }'

curl -X POST https://api.bland.ai/v1/sip/update \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+14150000000",
    "updates": {
      "type": "outbound",
      "sip_endpoint": "sip:your.provider.com", // Only available for outbound SIP Types.
      "options": { // Only available for outbound SIP Types.
          "port": 1234, // Will overwrite any port defined in your sip_endpoint.
          "transport": "tls", // Other available: tls, tcp, udp
          "secure_media": true, // True, False
          "sip_username": "bland", // Optional
          "sip_password": "password" // Optional
      }
    }
  }'

curl -X POST https://api.bland.ai/v1/sip/detach \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+14150000000",
    "directions": [
      { "type": "inbound" }
    ],
    "service": "sip"
  }'

curl -X POST https://api.bland.ai/v1/calls \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "task": "Say hi to the nice person!",
    "from": "+12341234123", // The number above registered as a SIP Outbound number.
    "phone_number": "<the callee's phone number>"
  }'

curl -X GET 'https://api.bland.ai/v1/sip?phone_number=+1231231234' \
  -H "Authorization: Bearer <token>"