Create External SWML Handler

POST 
/resources/external_swml_handlers

Creates an External SWML Handler

Request

application/json

Body

required

name string

Name of the External SWML Handler.

used_for string

Possible values: [calling]

Default value: calling

Used for of the External SWML Handler.

primary_request_url stringrequired

Primary request url of the External SWML Handler.

primary_request_method string

Possible values: [GET, POST]

Default value: POST

Primary request method of the External SWML Handler.

fallback_request_url string

Fallback request url of the External SWML Handler.

fallback_request_method string

Possible values: [GET, POST]

Default value: POST

Fallback request method of the External SWML Handler.

status_callback_url string

Status callback url of the External SWML Handler.

status_callback_method string

Possible values: [GET, POST]

Default value: POST

Status callback method of the External SWML Handler.

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

Schema

Schema

id uuidrequired

Universal Unique Identifier.

name stringrequired

Name of the External SWML Handler.

used_for stringrequired

Possible values: [calling]

Used for of the External SWML Handler.

primary_request_url stringrequired

Primary request url of the External SWML Handler.

primary_request_method UrlMethodType (string)required

Possible values: [GET, POST]

The method type to use for the URL

fallback_request_url stringrequired

Fallback request url of the External SWML Handler.

fallback_request_method UrlMethodType (string)required

Possible values: [GET, POST]

The method type to use for the URL

status_callback_url stringrequired

Status callback url of the External SWML Handler.

status_callback_method UrlMethodType (string)required

Possible values: [GET, POST]

The method type to use for the URL

Example (from schema)

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

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]

422

Client error

application/json

Schema

Schema

errors

object[]

required

Array [

type stringrequired

Error type.

code stringrequired

Error code.

message stringrequired

Error details.

attribute stringrequired

Request parameter associated with this error.

url stringrequired

Link to developer resource for this error.

]

Example (from schema)

{
  "errors": [
    {
      "type": "validation_error",
      "code": "http_url_required",
      "message": "This value must be an HTTP or HTTPS URL.",
      "attribute": "status_callback_url",
      "url": "https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes/#http_url_required"
    }
  ]
}

Loading...