Trunk Authentication

A Trunk Authentication is a method of authorizing calls into the system. This can either be by IP, or username/password

• GET/voip/trunk/{uuid}/auth

  Gets a list of all of the authentication methods for the given trunk

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Trunk to be queried

  Response Details

  200 Response

  {
      "result" : [
          {
              "created_on" : "2023-06-02",
              "ip" : "255.255.255.255",
              "password" : "secret",
              "type" : "ip",
              "updated_on" : "2023-06-02",
              "username" : "pete_plumber1",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• GET/voip/trunk/{uuid}/auth/{auth_uuid}

  Gets the details of a specific authentication method for the given trunk

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Trunk to be queried

  • • auth_uuid

    • String

    • True

    The UUID of the Trunk Authentication method to be queried

  Response Details

  200 Response

  {
      "result" : {
          "created_on" : "2023-06-02",
          "ip" : "255.255.255.255",
          "password" : "secret",
          "type" : "ip",
          "updated_on" : "2023-06-02",
          "username" : "pete_plumber1",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

  409 Response

  {
      "result" : {},
      "status_code" : 409,
      "status_message" : "Conflict"
  }

• POST/voip/trunk/{uuid}/auth

  Creates a new authentication method for the given trunk

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Trunk to be updated

  POST body

  • Name

  • Type

  • Required

  • • ip

    • String

    • True

    If type is 'ip', this is the IP Address we will use to authenticate incoming calls.

  • • password

    • String

    • True

    If type is 'sipuser', this is the SIP Password we will use to authenticate incoming calls.

  • • type

    • String

    • True

    The type of authentication method. Either 'ip' or 'sipuser'.

  • • username

    • String

    • True

    If type is 'sipuser', this is the SIP Username we will use to authenticate incoming calls.

  JSON all-fields example:

  {
      "ip" : "255.255.255.255",
      "password" : "secret",
      "type" : "ip",
      "username" : "pete_plumber1"
  }

  Response Details

  201 Response

  {
      "result" : {
          "created_on" : "2023-06-02",
          "ip" : "255.255.255.255",
          "password" : "secret",
          "type" : "ip",
          "username" : "pete_plumber1",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

  409 Response

  {
      "result" : {},
      "status_code" : 409,
      "status_message" : "Conflict"
  }

• DELETE/voip/trunk/{uuid}/auth/{auth_uuid}

  Deletes the specified trunk authentication method from the given trunk

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Trunk to be updated

  • • auth_uuid

    • String

    • True

    The UUID of the Trunk Authentication method to be deleted

  Response Details

  204 Response

  {
      "result" : {},
      "status_code" : 204,
      "status_message" : "No Content"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }