POST /services/cloudlink-gateway-trunks/v1

This method is used to add a new CloudLink Gateway Network Trunk.

To add the CloudLink gateway network trunk:

  1. Perform the authentication and login to the API. For more information, see POST /auth/login.

  2. Use POST /services/cloudlink-gateway-trunks/v1 to send an HTTP POST request to the authentication service.

  3. Click Try it Out option.

  4. Under Request body select application/json from drop-down list.

  5. Enter the request body parameter values as follows:
    {
  "ipAddress": "string",
  "sipPortNumber": 0,
  "transportProtocol": "string",
  "description": "string",
  "pbxUsername": "string",
  "pbxPassword": "string",
  "cloudlinkGatewayUsername": "string",
  "cloudlinkGatewayUserPassword": "string",
  "gsmCallthroughDeployNumber": "string"
}
    The following table describes the request body parameters.

    Parameter Name

    Sample Value

    Description

    >ipAddress

    String

    Enter the IP address or Host Name of the ClodLink Gateway.

    IP address format: Four groups of 3 digits, separated by dots.

    Options:

    • First group: 1-255

    • Second group: 0-255

    • Third group: 0-255

    • Fourth group: 0-255

    Examples:

    • 1xx.1xx.0.2x

    • se.mitel.com

    >sipPortNumber

    String

    The Port Number to be used for the communication on the ClouLink gateway.

    Format: 1 to 5 digits. Allowed values are 1-65535

    >transportProtocol

    TCP

    Select the protocol to be used for communication with the CloudLink gateway

    Options:

    • TCP

    • UDP

    • TLS

    Default is TCP.

    >description

    String

    Enter a short Description for the Trunk.

    Format: Up to 255 alphanumerical characters.

    >pbxUsername

    String

    Enter the MX-ONE User Name.

    Format: Used when the pbx authenticates SIP messages

    Example:

    • John

    • Lars Erik

    >pbxPassword

    String

    Enter the MX-ONE User Password.

    Format: Used when the pbx authenticates SIP messages

    Example:

    • John

    • Lars Erik
    >cloudlinkGatewayUsername

    String

    Enter the CloudLink Gateway User Name.

    Format: Used when the CloudLink Gateway authenticates SIP messages

    Example:

    • John

    • Lars Erik
    >cloudlinkGatewayUserPassword

    String

    Enter the CloudLink Gateway User Password.

    Format: Used when the CloudLink Gateway authenticates SIP messages

    Example:

    • John

    • Lars Erik
    >gsmCallthroughDeployNumber

    String

    Enter the GSM Call through Deploy number.

    Format: Used by the mobile phone to call the MiVO400 via the PSTN to be routed to the gateway (cloud)

    The number format is in E.164 "+ format"

    Example: +41326553391

    Pattern: ^\+[1-9]\d{1,14}$

  6. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/services/cloudlink-gateway-trunks/v1
    The following table lists the expected responses.

    Response Type

    Value

    Schema

    Valid Response

    201 Created

    		 
    {
  "gatewayId": "string",
  "ipOrFQDNAddress": "string",
  "sipPortNumber": 0,
  "transportProtocol": "string",
  "description": "string",
  "pbxUsername": "string",
  "pbxPassword": "string",
  "cloudlinkGatewayUsername": "string",
  "cloudlinkGatewayUserPassword": "string",
  "gsmCallthroughDeployNumber": "string"
}

    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable
Parent topic: CloudLink Gateway Network Trunks
↑