List SIP endpoints

GET 
/resources/sip_endpoints

List SIP endpoints

Responses

200

A list of SIP endpoints

application/json

Schema

Schema

• Array [

id uuid
Example: 993ed018-9e79-4e50-b97b-984bd5534095
project_id uuid
Example: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
display_name string
Example: Reception
type string
Example: sip_endpoint
created_at date-time
Example: 2024-01-02T00:00:00Z
updated_at date-time
Example: 2024-01-02T00:00:00Z

sip_endpoint

object

id uuid

A unique identifier for the SIP endpoint

username string

Example: 123456

password string

Example: 123456

caller_id string

Example: 123456

send_as string

Example: random

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]

Example: optional

call_handler string

Example: laml_webhooks

call_request_url uri

Example: https://example.com/call_handler

call_request_method string

Possible values: [GET, POST]

Example: POST

call_fallback_url uri

Example: https://example.com/call_handler

call_fallback_method string

Possible values: [GET, POST]

Example: POST

call_status_callback_url uri

Example: https://example.com/call_handler

call_status_callback_method string

Possible values: [GET, POST]

Example: POST

call_laml_application_id uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

call_ai_agent_id uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

call_flow_id uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

call_flow_version uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

call_dialogflow_agent_id uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

call_relay_context string

Example: office

call_video_room_id uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

call_relay_script_url uri

Example: https://example.com/relay_script

call_relay_script_method string

Possible values: [GET, POST]

Example: POST

calling_handler_resource_id uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

• ]

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"
    }
  }
]