Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Endpoints

Method

Path

Return Model

Summary

GET

/endpoints

List[Endpoint]

List all endpoints.

PUT

/endpoints/sendMessage

void

Send a message 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.

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 sip, pjsip, and xmpp.
  • from: string - (required) The endpoint resource or technology specific identity to send this message from. Valid resources are sip, 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

listByTech: GET /endpoints/{tech}

List available endoints for a given endpoint technology.

Path parameters

  • tech: string - Technology of the endpoints (sip,iax2,...)

Error Responses

  • 404 - Endpoints not found

get: GET /endpoints/{tech}/{resource}

Details for an endpoint.

Path parameters

  • 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

  • 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 sip, 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
  • No labels