SIP Users

A SIP User is a set of credentials that can be used to a configure a device to make and receive calls

• GET/voip/user

  Gets a list of all active SIP Users on an account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "call_encryption" : true,
              "call_recording" : true,
              "caller_id" : "634dd47d-fd00-43f9-8566-8e7674318f00",
              "can_barge" : true,
              "can_be_barged" : true,
              "can_be_listened" : true,
              "can_be_picked_up" : true,
              "can_be_whispered" : true,
              "can_invite_anonymously" : true,
              "can_listen" : true,
              "can_pickup" : true,
              "can_whisper" : true,
              "created_on" : "2020-09-27",
              "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
              "extension" : 1001,
              "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
              "name" : "pete_plumber_9",
              "nickname" : "Pete Plumber",
              "password" : "A3WcdxQ0iCk98hnbE1",
              "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
              "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
              "show_missed_calls" : true,
              "type" : 3,
              "updated_on" : "2020-09-27",
              "use_default_playlist" : true,
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/voip/user-status

  Gets the status of the all SIP Users on an account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "status" : "open",
              "uuid" : "1efbe2a5-2c21-4b2c-a316-798c18f0c123"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/voip/user/{uuid}

  Gets the details for a specific SIP User

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the SIP User to be queried

  Response Details

  200 Response

  {
      "result" : {
          "call_encryption" : true,
          "call_recording" : true,
          "caller_id" : "634dd47d-fd00-43f9-8566-8e7674318f00",
          "can_barge" : true,
          "can_be_barged" : true,
          "can_be_listened" : true,
          "can_be_picked_up" : true,
          "can_be_whispered" : true,
          "can_invite_anonymously" : true,
          "can_listen" : true,
          "can_pickup" : true,
          "can_whisper" : true,
          "created_on" : "2020-09-27",
          "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
          "extension" : 1001,
          "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
          "name" : "pete_plumber_9",
          "nickname" : "Pete Plumber",
          "password" : "A3WcdxQ0iCk98hnbE1",
          "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
          "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
          "show_missed_calls" : true,
          "type" : 3,
          "updated_on" : "2020-09-27",
          "use_default_playlist" : true,
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

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

• GET/voip/user/{uuid}/status

  Gets the status of the specified SIP User

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the SIP User to be queried

  Response Details

  200 Response

  {
      "result" : {
          "status" : "open",
          "uuid" : "1efbe2a5-2c21-4b2c-a316-798c18f0c123"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

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

• GET/voip/user/{uuid}/availability

  Gets the queue availability for a specific SIP User

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the SIP user to be queried

  Response Details

  200 Response

  {
      "result" : {
          "available" : true
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

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

• PUT/voip/user/{uuid}/availability

  Updates the queue availability for a specific SIP User

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the SIP user to be updated

  PUT body

  • Name

  • Type

  • Required

  • • available

    • Boolean

    • True

    The availability of the SIP User

  JSON all-fields example:

  {
      "available" : true
  }

  Response Details

  200 Response

  {
      "result" : {
          "available" : true
      },
      "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"
  }

• Chargeable *

  POST/voip/user

  Creates a new SIP User

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • call_encryption

    • boolean

    • False

    Whether or not this User's call encryption is enabled

  • • call_recording

    • boolean

    • False

    Whether or not this User's call recording is enabled

  • • caller_id

    • String

    • False

    The UUID of the Caller ID used for outbound calls

  • • can_barge

    • boolean

    • False

    Whether or not this User can use the Barge feature

  • • can_be_barged

    • boolean

    • False

    Whether or not this User's calls can be Barged to

  • • can_be_listened

    • boolean

    • False

    Whether or not this User's calls can be Listened to

  • • can_be_picked_up

    • boolean

    • False

    Whether or not this User's calls can be Picked up

  • • can_be_whispered

    • boolean

    • False

    Whether or not this User's calls can be Whispered to

  • • can_invite_anonymously

    • boolean

    • False

    Whether or not this User accepts invites from unknown sources

  • • can_listen

    • boolean

    • False

    Whether or not this User can use the Listen feature

  • • can_pickup

    • boolean

    • False

    Whether or not this User can use the Pickup feature

  • • can_whisper

    • boolean

    • False

    Whether or not this User can use the Whisper feature

  • • emergency_caller_id

    • String

    • False

    The UUID of the Caller ID used by the emergency services for outbound calls

  • • extension

    • int

    • True

    The extension number assigned to this User

  • • hold_playlist

    • String

    • False

    The UUID of the Playlist used as music on hold

  • • name

    • String

    • True

    The SIP Username for this User

  • • nickname

    • String

    • True

    The nickname for this User

  • • password

    • String

    • True

    The SIP Password for this User

  • • personal_mailbox

    • String

    • False

    The UUID of the Mailbox used as a personal mailbox

  • • related_product

    • String

    • True

    The UUID of the VoIP Bundle (subscription) to assign the SIP user to, see the /voip/bundle command to create a subscription

  • • show_missed_calls

    • boolean

    • False

    Whether or not calls answered by another User show in this User's missed calls list

  • • type

    • UserType

    • True

    The ID of the type of this User. The currently available types are as follows:
    3: PAYG
    4: UK Landline & Mobile
    5: UK + EU Landline & Mobile

  • • use_default_playlist

    • boolean

    • False

    Whether or not the User uses the default playlist for Music on Hold

  JSON all-fields example:

  {
      "call_encryption" : true,
      "call_recording" : true,
      "caller_id" : "634dd47d-fd00-43f9-8566-8e7674318f00",
      "can_barge" : true,
      "can_be_barged" : true,
      "can_be_listened" : true,
      "can_be_picked_up" : true,
      "can_be_whispered" : true,
      "can_invite_anonymously" : true,
      "can_listen" : true,
      "can_pickup" : true,
      "can_whisper" : true,
      "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
      "extension" : 1001,
      "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
      "name" : "pete_plumber_9",
      "nickname" : "Pete Plumber",
      "password" : "A3WcdxQ0iCk98hnbE1",
      "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
      "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
      "show_missed_calls" : true,
      "type" : 3,
      "use_default_playlist" : true
  }

  Response Details

  201 Response

  {
      "result" : {
          "call_encryption" : true,
          "call_recording" : true,
          "caller_id" : "634dd47d-fd00-43f9-8566-8e7674318f00",
          "can_barge" : true,
          "can_be_barged" : true,
          "can_be_listened" : true,
          "can_be_picked_up" : true,
          "can_be_whispered" : true,
          "can_invite_anonymously" : true,
          "can_listen" : true,
          "can_pickup" : true,
          "can_whisper" : true,
          "created_on" : "2020-09-27",
          "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
          "extension" : 1001,
          "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
          "name" : "pete_plumber_9",
          "nickname" : "Pete Plumber",
          "password" : "A3WcdxQ0iCk98hnbE1",
          "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
          "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
          "show_missed_calls" : true,
          "type" : 3,
          "use_default_playlist" : true,
          "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"
  }

• Chargeable *

  PUT/voip/user/{uuid}

  Updates the specified SIP User

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the SIP user to be updated

  PUT body

  • Name

  • Type

  • Required

  • • call_encryption

    • boolean

    • False

    Whether or not this User's call encryption is enabled

  • • call_recording

    • boolean

    • False

    Whether or not this User's call recording is enabled

  • • caller_id

    • String

    • False

    The UUID of the Caller ID used for outbound calls

  • • can_barge

    • boolean

    • False

    Whether or not this User can use the Barge feature

  • • can_be_barged

    • boolean

    • False

    Whether or not this User's calls can be Barged to

  • • can_be_listened

    • boolean

    • False

    Whether or not this User's calls can be Listened to

  • • can_be_picked_up

    • boolean

    • False

    Whether or not this User's calls can be Picked up

  • • can_be_whispered

    • boolean

    • False

    Whether or not this User's calls can be Whispered to

  • • can_invite_anonymously

    • boolean

    • False

    Whether or not this User accepts invites from unknown sources

  • • can_listen

    • boolean

    • False

    Whether or not this User can use the Listen feature

  • • can_pickup

    • boolean

    • False

    Whether or not this User can use the Pickup feature

  • • can_whisper

    • boolean

    • False

    Whether or not this User can use the Whisper feature

  • • emergency_caller_id

    • String

    • False

    The UUID of the Caller ID used by the emergency services for outbound calls

  • • extension

    • int

    • True

    The extension number assigned to this User

  • • hold_playlist

    • String

    • False

    The UUID of the Playlist used as music on hold

  • • name

    • String

    • True

    The SIP Username for this User

  • • nickname

    • String

    • True

    The nickname for this User

  • • password

    • String

    • True

    The SIP Password for this User

  • • personal_mailbox

    • String

    • False

    The UUID of the Mailbox used as a personal mailbox

  • • related_product

    • String

    • True

    The UUID of the VoIP Bundle (subscription) to assign the SIP user to, see the /voip/bundle command to create a subscription

  • • show_missed_calls

    • boolean

    • False

    Whether or not calls answered by another User show in this User's missed calls list

  • • type

    • UserType

    • True

    The ID of the type of this User. The currently available types are as follows:
    3: PAYG
    4: UK Landline & Mobile
    5: UK + EU Landline & Mobile

  • • use_default_playlist

    • boolean

    • False

    Whether or not the User uses the default playlist for Music on Hold

  JSON all-fields example:

  {
      "call_encryption" : true,
      "call_recording" : true,
      "caller_id" : "634dd47d-fd00-43f9-8566-8e7674318f00",
      "can_barge" : true,
      "can_be_barged" : true,
      "can_be_listened" : true,
      "can_be_picked_up" : true,
      "can_be_whispered" : true,
      "can_invite_anonymously" : true,
      "can_listen" : true,
      "can_pickup" : true,
      "can_whisper" : true,
      "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
      "extension" : 1001,
      "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
      "name" : "pete_plumber_9",
      "nickname" : "Pete Plumber",
      "password" : "A3WcdxQ0iCk98hnbE1",
      "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
      "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
      "show_missed_calls" : true,
      "type" : 3,
      "use_default_playlist" : true
  }

  Response Details

  200 Response

  {
      "result" : {
          "call_encryption" : true,
          "call_recording" : true,
          "caller_id" : "634dd47d-fd00-43f9-8566-8e7674318f00",
          "can_barge" : true,
          "can_be_barged" : true,
          "can_be_listened" : true,
          "can_be_picked_up" : true,
          "can_be_whispered" : true,
          "can_invite_anonymously" : true,
          "can_listen" : true,
          "can_pickup" : true,
          "can_whisper" : true,
          "created_on" : "2020-09-27",
          "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
          "extension" : 1001,
          "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
          "name" : "pete_plumber_9",
          "nickname" : "Pete Plumber",
          "password" : "A3WcdxQ0iCk98hnbE1",
          "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
          "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
          "show_missed_calls" : true,
          "type" : 3,
          "updated_on" : "2020-09-27",
          "use_default_playlist" : true,
          "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"
  }

• PUT/voip/user/{uuid}/restore

  Restores the specified deleted SIP User

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the SIP user to be restored

  Response Details

  201 Response

  {
      "result" : {
          "call_encryption" : true,
          "call_recording" : true,
          "caller_id" : "634dd47d-fd00-43f9-8566-8e7674318f00",
          "can_barge" : true,
          "can_be_barged" : true,
          "can_be_listened" : true,
          "can_be_picked_up" : true,
          "can_be_whispered" : true,
          "can_invite_anonymously" : true,
          "can_listen" : true,
          "can_pickup" : true,
          "can_whisper" : true,
          "created_on" : "2020-09-27",
          "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
          "extension" : 1001,
          "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
          "name" : "pete_plumber_9",
          "nickname" : "Pete Plumber",
          "password" : "A3WcdxQ0iCk98hnbE1",
          "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
          "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
          "show_missed_calls" : true,
          "type" : 3,
          "updated_on" : "2020-09-27",
          "use_default_playlist" : true,
          "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"
  }

• GET/voip/next-extension/user

  Gets the next valid SIP User extension

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  400 Response

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

  404 Response

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

• DELETE/voip/user/{uuid}

  Deletes the specified SIP User

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the SIP user 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"
  }