Skip to content

Endpoints

Method Path (Parameters are case-sensitive) Return Model Summary
GET /endpoints List[Endpoint] List all endpoints.
PUT /endpoints/sendMessage void Send a message to some technology URI or endpoint.
POST /endpoints/refer void Refer an endpoint or technology URI to some technology URI or endpoint.
GET /endpoints/{tech} List[Endpoint] List available endoints for a given endpoint technology.
GET /endpoints/{tech}/{resource} Endpoint Details for an endpoint.
PUT /endpoints/{tech}/{resource}/sendMessage void Send a message to some endpoint in a technology.
POST /endpoints/{tech}/{resource}/refer void Refer an endpoint or technology URI to some technology URI or endpoint.

list

GET /endpoints

List all endpoints.


sendMessage

PUT /endpoints/sendMessage

Send a message to some technology URI or endpoint.

Query parameters

  • to: string - (required) The endpoint resource or technology specific URI to send the message to. Valid resources are pjsip, and xmpp.
  • from: string - (required) The endpoint resource or technology specific identity to send this message from. Valid resources are pjsip, and xmpp.
  • body: string - The body of the message

Body parameter

  • variables: containers -

Error Responses

  • 400 - Invalid parameters for sending a message.
  • 404 - Endpoint not found

refer

POST /endpoints/refer

Refer an endpoint or technology URI to some technology URI or endpoint.

Query parameters

  • to: string - (required) The endpoint resource or technology specific URI that should be referred to somewhere. Valid resource is pjsip.
  • from: string - (required) The endpoint resource or technology specific identity to refer from.
  • refer_to: string - (required) The endpoint resource or technology specific URI to refer to.
  • to_self: boolean - If true and "refer_to" refers to an Asterisk endpoint, the "refer_to" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint.

Body parameter

  • variables: containers - The "variables" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers. The "display_name" key is used by the PJSIP technology. Its value will be prepended as a display name to the Refer-To URI.

Error Responses

  • 400 - Invalid parameters for referring.
  • 404 - Endpoint not found

listByTech

GET /endpoints/{tech}

List available endoints for a given endpoint technology.

Path parameters

Parameters are case-sensitive. * tech: string - Technology of the endpoints (pjsip,iax2,...)

Error Responses

  • 404 - Endpoints not found

get

GET /endpoints/{tech}/{resource}

Details for an endpoint.

Path parameters

Parameters are case-sensitive. * tech: string - Technology of the endpoint * resource: string - ID of the endpoint

Error Responses

  • 400 - Invalid parameters for sending a message.
  • 404 - Endpoints not found

sendMessageToEndpoint

PUT /endpoints/{tech}/{resource}/sendMessage

Send a message to some endpoint in a technology.

Path parameters

Parameters are case-sensitive. * tech: string - Technology of the endpoint * resource: string - ID of the endpoint

Query parameters

  • from: string - (required) The endpoint resource or technology specific identity to send this message from. Valid resources are pjsip and xmpp.
  • body: string - The body of the message

Body parameter

  • variables: containers -

Error Responses

  • 400 - Invalid parameters for sending a message.
  • 404 - Endpoint not found

referToEndpoint

POST /endpoints/{tech}/{resource}/refer

Refer an endpoint or technology URI to some technology URI or endpoint.

Path parameters

Parameters are case-sensitive. * tech: string - Technology of the endpoint * resource: string - ID of the endpoint

Query parameters

  • from: string - (required) The endpoint resource or technology specific identity to refer from.
  • refer_to: string - (required) The endpoint resource or technology specific URI to refer to.
  • to_self: boolean - If true and "refer_to" refers to an Asterisk endpoint, the "refer_to" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint.

Body parameter

  • variables: containers - The "variables" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers,

Error Responses

  • 400 - Invalid parameters for referring.
  • 404 - Endpoint not found