Create SIP Gateway

View as Markdown
Creates a SIP Gateway that can be used to dial external SIP entities. #### 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](/docs/platform/your-signalwire-api-space).

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) ```

Request

This endpoint expects an object.
namestringRequired
Display name for the SIP Gateway.
uristringRequired
External SIP URI.
encryptionenumRequired
Specifies the encryption requirement for the SIP connection.
Allowed values:
cipherslist of enumsRequired
List of supported SIP ciphers.
Allowed values:
codecslist of enumsRequired
List of supported codecs for media transmission.

Response

The request has succeeded and a new resource has been created as a result.
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