List External SWML Handlers

GET 
/resources/external_swml_handlers

A list of External SWML Handlers

Request

Responses

200

The request has succeeded.

application/json

Schema

Schema

data

object[]

required

Array [

iduuidrequired

Universal Unique Identifier.

namestringrequired

Name of the External SWML Handler.

Example: My External SWML Handler

used_forstringrequired

Used for of the External SWML Handler.

Possible values: [calling]

Example: calling

primary_request_urlstringrequired

Primary request url of the External SWML Handler.

Example: https://primary.com

primary_request_methodUrlMethodType (string)required

The method type to use for the URL

Possible values: [GET, POST]

fallback_request_urlstringrequired

Fallback request url of the External SWML Handler.

Example: https://fallback.com

fallback_request_methodUrlMethodType (string)required

The method type to use for the URL

Possible values: [GET, POST]

status_callback_urlstringrequired

Status callback url of the External SWML Handler.

Example: https://callback.com

status_callback_methodUrlMethodType (string)required

The method type to use for the URL

Possible values: [GET, POST]

]

links

object

required

selfurirequired

Link of the current page

Example: https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=0&page_size=50

firsturirequired

Link to the first page

Example: https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=0&page_size=50

nexturirequired

Link to the next page

Example: https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca

Example (from schema)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "My External SWML Handler",
      "used_for": "calling",
      "primary_request_url": "https://primary.com",
      "primary_request_method": "GET",
      "fallback_request_url": "https://fallback.com",
      "fallback_request_method": "GET",
      "status_callback_url": "https://callback.com",
      "status_callback_method": "GET"
    }
  ],
  "links": {
    "self": "https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=0&page_size=50",
    "first": "https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=0&page_size=50",
    "next": "https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  }
}

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]