Create SIP endpoint

POST 
/resources/sip_endpoints

Create SIP endpoint

Request

application/json

Body

required

username string
password string
caller_id string
send_as string
ciphers string[]

Possible values: [AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, AES_CM_128_HMAC_SHA1_32]

codecs string[]

Possible values: [PCMU, PCMA, G722, G729, OPUS, VP8, H264]

encryption string

Possible values: [required, optional]

call_handler string
call_request_url uri
call_request_method string

Possible values: [GET, POST]

call_fallback_url uri
call_fallback_method string

Possible values: [GET, POST]

call_status_callback_url uri
call_status_callback_method string

Possible values: [GET, POST]

call_laml_application_id uuid
call_ai_agent_id uuid
call_flow_id uuid
call_flow_version uuid
call_dialogflow_agent_id uuid
call_relay_context string
call_video_room_id uuid
call_relay_script_url uri
call_relay_script_method string

Possible values: [GET, POST]

calling_handler_resource_id uuid

Responses

200

A SIP endpoint

application/json

Schema

Schema

id uuid
project_id uuid
display_name string
type string
created_at date-time
updated_at date-time

sip_endpoint

object

id uuid

A unique identifier for the SIP endpoint

username string

password string

caller_id string

send_as string

ciphers string[]

Possible values: [AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, AES_CM_128_HMAC_SHA1_32]

codecs string[]

Possible values: [PCMU, PCMA, G722, G729, OPUS, VP8, H264]

encryption string

Possible values: [required, optional]

call_handler string

call_request_url uri

call_request_method string

Possible values: [GET, POST]

call_fallback_url uri

call_fallback_method string

Possible values: [GET, POST]

call_status_callback_url uri

call_status_callback_method string

Possible values: [GET, POST]

call_laml_application_id uuid

call_ai_agent_id uuid

call_flow_id uuid

call_flow_version uuid

call_dialogflow_agent_id uuid

call_relay_context string

call_video_room_id uuid

call_relay_script_url uri

call_relay_script_method string

Possible values: [GET, POST]

calling_handler_resource_id uuid

Example (from schema)

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reception",
  "type": "sip_endpoint",
  "created_at": "2024-01-02T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "sip_endpoint": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": 123456,
    "password": 123456,
    "caller_id": 123456,
    "send_as": "random",
    "ciphers": [
      "AEAD_AES_256_GCM_8"
    ],
    "codecs": [
      "PCMU"
    ],
    "encryption": "optional",
    "call_handler": "laml_webhooks",
    "call_request_url": "https://example.com/call_handler",
    "call_request_method": "POST",
    "call_fallback_url": "https://example.com/call_handler",
    "call_fallback_method": "POST",
    "call_status_callback_url": "https://example.com/call_handler",
    "call_status_callback_method": "POST",
    "call_laml_application_id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "call_ai_agent_id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "call_flow_id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "call_flow_version": "993ed018-9e79-4e50-b97b-984bd5534095",
    "call_dialogflow_agent_id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "call_relay_context": "office",
    "call_video_room_id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "call_relay_script_url": "https://example.com/relay_script",
    "call_relay_script_method": "POST",
    "calling_handler_resource_id": "993ed018-9e79-4e50-b97b-984bd5534095"
  }
}

422

Unprocessable Entity

application/json

Schema

Schema

type stringrequired
code stringrequired
message stringrequired
attribute string
url urirequired

Example (from schema)

{
  "type": "validation_error",
  "code": "invalid_parameter",
  "message": "Name must be present",
  "attribute": "name",
  "url": "https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes#invalid_parameter"
}

Loading...