Get SIP Gateway

View as Markdown

Returns an SIP Gateway by ID

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a SIP Gateway.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the resource.
project_idstringformat: "uuid"
Project ID associated with the resource.
display_namestring
Display name of the SIP Gateway.
typeenum
Type of the resource.
Allowed values:
created_atdatetime
Timestamp when the resource was created.
updated_atdatetime
Timestamp when the resource was last updated.
sip_gatewayobject
SIP Gateway configuration details.

Errors