Loading

Error Sorry

Yay.com - VoIP Business Phone Service Provider
  • Voice
    • Compare Voice Plans
    • Call Costs
    • Voice Features
    • Chat Features
    • Hosted Voice Reseller
    • VoIP Free 14 Day Trial
    • Business Phone Systems
  • Phone Numbers
    • All Phone Numbers
    • Transfer your Phone Number
    • New York 917 Numbers
    • Los Angeles 213 Numbers
    • Chicago 773 Numbers
    • Houston 832 Numbers
    • San Francisco 628 Numbers
    • Seattle 206 Numbers
    • Washington DC 202 Numbers
    • International Phone Numbers
  • Domain Names
    • Domain Name Search
    • Domain Transfer
    • Domain Backorders
    • Domain Registration Pricing
    • Bulk Domain Name Search
    • Domain Name Registration
    • Domain Name Reseller
  • Downloads
    • Download for Desktop
    • Download for iOS
    • Download for Android
  • Integrations
    • Phone System Integrations
    • Microsoft Teams Direct Routing
    • VoIP API Docs
    • Domain Name API Docs
  • Help & About
    • About us
    • Policy & Accreditations
    • Reviews
    • Frequent Questions
    • Read Blog
    • VoIP News
    • Contact us
  • Hello! Log in Your Account

    Log in

    New customer? Start here

  • 0

    Cart Total

    $0.00


    • Your shopping cart is empty


    Checkout

    Delete everything ?

Yay.com - VoIP Business Phone Service Provider
0
  • Voice

    • Compare Voice Plans
    • Call Costs
    • Voice Features
    • Chat Features
    • Hosted Voice Reseller
    • VoIP Free 14 Day Trial
    • Business Phone Systems
  • Phone Numbers

    • All Phone Numbers
    • Transfer your Phone Number
    • New York 917 Numbers
    • Los Angeles 213 Numbers
    • Chicago 773 Numbers
    • Houston 832 Numbers
    • San Francisco 628 Numbers
    • Seattle 206 Numbers
    • Washington DC 202 Numbers
    • International Phone Numbers
  • Domain Names

    • Domain Name Search
    • Domain Transfer
    • Domain Backorders
    • Domain Registration Pricing
    • Bulk Domain Name Search
    • Domain Name Registration
    • Domain Name Reseller
  • Integrations

    • Phone System Integrations
    • Microsoft Teams Direct Routing
    • VoIP API Docs
    • Domain Name API Docs
  • Downloads

    • Download for Desktop
    • Download for iOS
    • Download for Android
  • Help & About

    • About us
    • Policy & Accreditations
    • Reviews
    • Frequent Questions
    • Read Blog
    • VoIP News
    • Contact us

Cart Total

$0.00

  • Your shopping cart is empty

Checkout

Delete everything ?

SIP Account Management

  • Storefronts

    • Invoices
    • Credit Notes
  • Customer Management

    • Reseller Account Balances
    • Reseller Addresses
    • Sub Resellers
    • Reseller Users
    • Documents
    • Storefronts
    • Integrations
    • Bank Accounts
    • Revenue Withdrawal
    • Discount
  • VoIP Bundle (Subscriptions)

    • VoIP Subscription Bundle
  • SIP Account Management

    • Hunt Groups
    • SIP Users
    • App Configuration
  • Audio Management

    • Sounds
    • Playlists
  • Phone Numbers & Call Routing

    • Call Flows, Call Route
    • Number Transfers
    • Time Diaries
    • Phone Numbers
    • Number Search
    • Emergency Address
    • Number Address
  • Phone Calls & CDR Data

    • Phone Call Packs
    • Call Recording Retention
    • Phone Call Costs
    • Phone Call History
    • Phone Call Restrictions
    • Outbound Calls
    • Call Statistics Reporting
    • Missed Call Notifications
    • Call Statistics
    • Outbound Calls
  • VoIP Phone Short Code

    • Short Codes
  • eFax Management

    • Fax Messages
    • Fax Authorized Senders
  • Voicemails & Mailboxes

    • Mailboxes
    • Mailbox Menus
    • Mailbox Email Recipients
    • Mailbox Messages
  • Caller ID

    • Caller IDs
    • Caller ID Requests
  • SIP Trunks

    • Trunk Authentication
    • VoIP Trunks
  • Wallboard Statistics

  • VoIP Phone Provisioning

    • Devices
  • Call Queueing

    • Queue Stats
    • Queue Notices
    • Queue Groups
  • Phone Books

    • Phone Book
    • Phone Book Contact
  • VoIP Phone Speed Dial

    • Speed Dials
  • Text (SMS) Messaging

    • Text Message Campaign

API Access

Build custom apps using our JSON API

Configure API
Yay.com Customer Reviews
apple-store google-play

Latest

News

  • Enhance Support With Our Intercom App Phone Integration
    Adrian - Digital Marketing at Yay.com

    Adrian - December 20 2022

  • Yay.com Receives Private Equity Investment To Accelerate Channel Offering
    Adrian - Digital Marketing at Yay.com

    Adrian - November 25 2022

  • Yay.com Awarded G-Cloud 13 Supplier Status
    Adrian - Digital Marketing at Yay.com

    Adrian - November 22 2022

SIP Users

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

Become a Reseller

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • 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" : [
            {
                "allow_direct_calls" : true,
                "allow_multi_device" : true,
                "allowed_caller_ids" : "884b3094-5775-47b0-bc8b-566448892175",
                "call_encryption" : true,
                "call_recording" : true,
                "caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
                "can_auto_deploy" : true,
                "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,
                "chat_enabled" : true,
                "country_code" : "GB",
                "created_on" : "2023-02-04",
                "display_name" : "Pete Plumber",
                "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
                "extension" : 1001,
                "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
                "mobile_dnd" : false,
                "mobile_dnd_allow_internal" : true,
                "mute_chat_notifications" : false,
                "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
                "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
                "restrict_caller_id" : true,
                "restrict_outbound" : false,
                "ring_duration" : 10,
                "show_missed_calls" : true,
                "timezone" : "Europe/London",
                "transfer_backup_extension" : 1002,
                "type" : 9,
                "updated_on" : "2023-02-04",
                "use_default_playlist" : true,
                "use_direct_calls" : true,
                "use_mailbox_on_transfer" : true,
                "user_name" : "pete_plumber_9",
                "user_password" : "A3WcdxQ0iCk98hnbE1",
                "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" : {
            "allow_direct_calls" : true,
            "allow_multi_device" : true,
            "allowed_caller_ids" : "884b3094-5775-47b0-bc8b-566448892175",
            "call_encryption" : true,
            "call_recording" : true,
            "caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
            "can_auto_deploy" : true,
            "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,
            "chat_enabled" : true,
            "country_code" : "GB",
            "created_on" : "2023-02-04",
            "display_name" : "Pete Plumber",
            "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
            "extension" : 1001,
            "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
            "mobile_dnd" : false,
            "mobile_dnd_allow_internal" : true,
            "mute_chat_notifications" : false,
            "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
            "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
            "restrict_caller_id" : true,
            "restrict_outbound" : false,
            "ring_duration" : 10,
            "show_missed_calls" : true,
            "timezone" : "Europe/London",
            "transfer_backup_extension" : 1002,
            "type" : 9,
            "updated_on" : "2023-02-04",
            "use_default_playlist" : true,
            "use_direct_calls" : true,
            "use_mailbox_on_transfer" : true,
            "user_name" : "pete_plumber_9",
            "user_password" : "A3WcdxQ0iCk98hnbE1",
            "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

      • allow_direct_calls

      • Boolean

      • False

      Should this SIP user be reachable by their mobile number activated on the app

      • allow_multi_device

      • Boolean

      • False

      Indicates if this user may link additional mobile devices using the QR code option

      • allowed_caller_ids

      • Array of String

      • False

      List of Caller ID UUID's that the user is allowed to set

      • 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 to be used, if restrict_caller_id is set, this must be one of the allowed UUIDs

      • can_auto_deploy

      • Boolean

      • False

      When set to true, this user can be automatically assigned to the mobile apps when a company code is used

      • 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

      • chat_enabled

      • Boolean

      • False

      Should this user be able to use the chat feature in the mobile and desktop apps

      • country_code

      • String

      • False

      The default country for this user, this will remove the need to provide the +/00 country prefix on outbound calls to this country

      • display_name

      • String

      • True

      The nickname for this User

      • emergency_caller_id

      • String

      • False

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

      • extension

      • Integer

      • True

      The extension number assigned to this User

      • hold_playlist

      • String

      • False

      The UUID of the Playlist used as music on hold

      • mobile_dnd

      • Boolean

      • False

      Do not send inbound calls to the users mobile apps when set to true

      • mobile_dnd_allow_internal

      • Boolean

      • False

      When mobile_dnd is true, this setting allows internal calls (from the same account) to still be sent to the user, please note, this setting will not override the native DND setting on the users device

      • mute_chat_notifications

      • Boolean

      • False

      Mutes all chat push notifications to the users mobile apps when set to true

      • personal_mailbox

      • String

      • False

      The UUID of the Mailbox used as a personal mailbox

      • related_product

      • String

      • True

      The Voip Bundle UUID to link this user to

      • restrict_caller_id

      • boolean

      • False

      Should this user be limited in which caller ID's they can be assigned

      • restrict_outbound

      • Boolean

      • False

      Allows outbound calling to be disabled for this SIP user

      • ring_duration

      • Integer

      • False

      How long to ring this SIP user for

      • show_missed_calls

      • Boolean

      • False

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

      • timezone

      • String

      • False

      The Unix timezone to use for the user, for example this will change the time played on mailbox messages

      • transfer_backup_extension

      • Integer

      • False

      If the user does not answer on a blind transfer, redirect to this extension

      • type

      • VoipUserType

      • True

      The type of user to be created, the type must match the VoIP Bundle on the account

      Starting Out is type 8 (with minutes) or 14 (pay as you go)
      Flying High is 9 (with minutes) or 15 (pay as you go)
      Enterprise is 10 (unlimited) or 16 (pay as you go)

      • use_default_playlist

      • Boolean

      • False

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

      • use_direct_calls

      • Boolean

      • False

      When calling an external number, should this user attempt to call via the Yay.com platform initially

      • use_mailbox_on_transfer

      • Boolean

      • False

      Go to the users personal mailbox if they do not answer during a blind transfer

      • user_name

      • String

      • True

      The SIP Username for this User

      • user_password

      • String

      • True

      The SIP Password for this User

    JSON all-fields example:

    {
        "allow_direct_calls" : true,
        "allow_multi_device" : true,
        "allowed_caller_ids" : "884b3094-5775-47b0-bc8b-566448892175",
        "call_encryption" : true,
        "call_recording" : true,
        "caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
        "can_auto_deploy" : true,
        "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,
        "chat_enabled" : true,
        "country_code" : "GB",
        "display_name" : "Pete Plumber",
        "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
        "extension" : 1001,
        "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
        "mobile_dnd" : false,
        "mobile_dnd_allow_internal" : true,
        "mute_chat_notifications" : false,
        "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
        "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
        "restrict_caller_id" : true,
        "restrict_outbound" : false,
        "ring_duration" : 10,
        "show_missed_calls" : true,
        "timezone" : "Europe/London",
        "transfer_backup_extension" : 1002,
        "type" : 9,
        "use_default_playlist" : true,
        "use_direct_calls" : true,
        "use_mailbox_on_transfer" : true,
        "user_name" : "pete_plumber_9",
        "user_password" : "A3WcdxQ0iCk98hnbE1"
    }

    Response Details

    201 Response

    {
        "result" : {
            "allow_direct_calls" : true,
            "allow_multi_device" : true,
            "allowed_caller_ids" : "884b3094-5775-47b0-bc8b-566448892175",
            "call_encryption" : true,
            "call_recording" : true,
            "caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
            "can_auto_deploy" : true,
            "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,
            "chat_enabled" : true,
            "country_code" : "GB",
            "created_on" : "2023-02-04",
            "display_name" : "Pete Plumber",
            "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
            "extension" : 1001,
            "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
            "mobile_dnd" : false,
            "mobile_dnd_allow_internal" : true,
            "mute_chat_notifications" : false,
            "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
            "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
            "restrict_caller_id" : true,
            "restrict_outbound" : false,
            "ring_duration" : 10,
            "show_missed_calls" : true,
            "timezone" : "Europe/London",
            "transfer_backup_extension" : 1002,
            "type" : 9,
            "use_default_playlist" : true,
            "use_direct_calls" : true,
            "use_mailbox_on_transfer" : true,
            "user_name" : "pete_plumber_9",
            "user_password" : "A3WcdxQ0iCk98hnbE1",
            "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

      • allow_direct_calls

      • Boolean

      • False

      Should this SIP user be reachable by their mobile number activated on the app

      • allow_multi_device

      • Boolean

      • False

      Indicates if this user may link additional mobile devices using the QR code option

      • allowed_caller_ids

      • Array of String

      • False

      List of Caller ID UUID's that the user is allowed to set

      • 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 to be used, if restrict_caller_id is set, this must be one of the allowed UUIDs

      • can_auto_deploy

      • Boolean

      • False

      When set to true, this user can be automatically assigned to the mobile apps when a company code is used

      • 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

      • chat_enabled

      • Boolean

      • False

      Should this user be able to use the chat feature in the mobile and desktop apps

      • country_code

      • String

      • False

      The default country for this user, this will remove the need to provide the +/00 country prefix on outbound calls to this country

      • display_name

      • String

      • True

      The nickname for this User

      • emergency_caller_id

      • String

      • False

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

      • extension

      • Integer

      • True

      The extension number assigned to this User

      • hold_playlist

      • String

      • False

      The UUID of the Playlist used as music on hold

      • mobile_dnd

      • Boolean

      • False

      Do not send inbound calls to the users mobile apps when set to true

      • mobile_dnd_allow_internal

      • Boolean

      • False

      When mobile_dnd is true, this setting allows internal calls (from the same account) to still be sent to the user, please note, this setting will not override the native DND setting on the users device

      • mute_chat_notifications

      • Boolean

      • False

      Mutes all chat push notifications to the users mobile apps when set to true

      • personal_mailbox

      • String

      • False

      The UUID of the Mailbox used as a personal mailbox

      • related_product

      • String

      • True

      The Voip Bundle UUID to link this user to

      • restrict_caller_id

      • boolean

      • False

      Should this user be limited in which caller ID's they can be assigned

      • restrict_outbound

      • Boolean

      • False

      Allows outbound calling to be disabled for this SIP user

      • ring_duration

      • Integer

      • False

      How long to ring this SIP user for

      • show_missed_calls

      • Boolean

      • False

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

      • timezone

      • String

      • False

      The Unix timezone to use for the user, for example this will change the time played on mailbox messages

      • transfer_backup_extension

      • Integer

      • False

      If the user does not answer on a blind transfer, redirect to this extension

      • type

      • VoipUserType

      • True

      The type of user to be created, the type must match the VoIP Bundle on the account

      Starting Out is type 8 (with minutes) or 14 (pay as you go)
      Flying High is 9 (with minutes) or 15 (pay as you go)
      Enterprise is 10 (unlimited) or 16 (pay as you go)

      • use_default_playlist

      • Boolean

      • False

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

      • use_direct_calls

      • Boolean

      • False

      When calling an external number, should this user attempt to call via the Yay.com platform initially

      • use_mailbox_on_transfer

      • Boolean

      • False

      Go to the users personal mailbox if they do not answer during a blind transfer

      • user_name

      • String

      • True

      The SIP Username for this User

      • user_password

      • String

      • True

      The SIP Password for this User

    JSON all-fields example:

    {
        "allow_direct_calls" : true,
        "allow_multi_device" : true,
        "allowed_caller_ids" : "884b3094-5775-47b0-bc8b-566448892175",
        "call_encryption" : true,
        "call_recording" : true,
        "caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
        "can_auto_deploy" : true,
        "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,
        "chat_enabled" : true,
        "country_code" : "GB",
        "display_name" : "Pete Plumber",
        "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
        "extension" : 1001,
        "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
        "mobile_dnd" : false,
        "mobile_dnd_allow_internal" : true,
        "mute_chat_notifications" : false,
        "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
        "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
        "restrict_caller_id" : true,
        "restrict_outbound" : false,
        "ring_duration" : 10,
        "show_missed_calls" : true,
        "timezone" : "Europe/London",
        "transfer_backup_extension" : 1002,
        "type" : 9,
        "use_default_playlist" : true,
        "use_direct_calls" : true,
        "use_mailbox_on_transfer" : true,
        "user_name" : "pete_plumber_9",
        "user_password" : "A3WcdxQ0iCk98hnbE1"
    }

    Response Details

    200 Response

    {
        "result" : {
            "allow_direct_calls" : true,
            "allow_multi_device" : true,
            "allowed_caller_ids" : "884b3094-5775-47b0-bc8b-566448892175",
            "call_encryption" : true,
            "call_recording" : true,
            "caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
            "can_auto_deploy" : true,
            "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,
            "chat_enabled" : true,
            "country_code" : "GB",
            "created_on" : "2023-02-04",
            "display_name" : "Pete Plumber",
            "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
            "extension" : 1001,
            "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
            "mobile_dnd" : false,
            "mobile_dnd_allow_internal" : true,
            "mute_chat_notifications" : false,
            "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
            "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
            "restrict_caller_id" : true,
            "restrict_outbound" : false,
            "ring_duration" : 10,
            "show_missed_calls" : true,
            "timezone" : "Europe/London",
            "transfer_backup_extension" : 1002,
            "type" : 9,
            "updated_on" : "2023-02-04",
            "use_default_playlist" : true,
            "use_direct_calls" : true,
            "use_mailbox_on_transfer" : true,
            "user_name" : "pete_plumber_9",
            "user_password" : "A3WcdxQ0iCk98hnbE1",
            "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" : {
            "allow_direct_calls" : true,
            "allow_multi_device" : true,
            "allowed_caller_ids" : "884b3094-5775-47b0-bc8b-566448892175",
            "call_encryption" : true,
            "call_recording" : true,
            "caller_id" : "fc97acdc-9e34-44be-b983-13fe8ef26fb0",
            "can_auto_deploy" : true,
            "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,
            "chat_enabled" : true,
            "country_code" : "GB",
            "created_on" : "2023-02-04",
            "display_name" : "Pete Plumber",
            "emergency_caller_id" : "595099fa-9aac-464a-a4bd-dee53fe67777",
            "extension" : 1001,
            "hold_playlist" : "7cc8f9aa-4480-4aad-b22a-5bb5cb40bc2d",
            "mobile_dnd" : false,
            "mobile_dnd_allow_internal" : true,
            "mute_chat_notifications" : false,
            "personal_mailbox" : "6431abcd-f7de-4bda-ae6e-29516f344e45",
            "related_product" : "a3950459-2aff-413b-9da0-86f45f815410",
            "restrict_caller_id" : true,
            "restrict_outbound" : false,
            "ring_duration" : 10,
            "show_missed_calls" : true,
            "timezone" : "Europe/London",
            "transfer_backup_extension" : 1002,
            "type" : 9,
            "updated_on" : "2023-02-04",
            "use_default_playlist" : true,
            "use_direct_calls" : true,
            "use_mailbox_on_transfer" : true,
            "user_name" : "pete_plumber_9",
            "user_password" : "A3WcdxQ0iCk98hnbE1",
            "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"
    }
ISO 27001 Business Continuity Accreditation ISO 22301 Business Continuity Accreditation Cyber Essentials Certificate of Assurance G-Cloud accredited by the Crown Commercial Service
  • VoIP Provider

    VoIP Provider

    Business VoIP Number Transfer number to VoIP Cloud PBX Phone System PAYG VoIP Call Costs VoIP Phone Numbers Business Phone System Features
  • Hosted VoIP Plans

    Hosted VoIP Plans

    VoIP Trial Account Business VoIP
    SIP Trunks
    SIP Provider SIP Trunking
  • Resellers

    Resellers

    VoIP Reseller Domain Reseller White Label VoIP Reseller
    Domain Names

    Domain Names

    Domain Name Search Domain Transfer Backorder Domains Domain Name Registration Domain Name Features
  • Help & Contact

    Help & Contact

    Contact Us Frequently Asked Questions Download Yay.com Apps Advantages of VoIP What is VoIP? VoIP Beginner's Guide VoIP API Documentation Domain API Documentation
  • Login / Register

    Login / Register

    About Yay Our News Our Blogs Terms & Conditions Privacy Policy
  • Accreditations
    ISO 27001 ISO 22301 Cyber Essentials G. Cloud Framework
Yay.com Business Phone Systems on YouTube Yay.com Business Phone Systems on Twitter Yay.com Business Phone Systems on Facebook Yay.com Business Phone Systems on LinkedIn
Yay.com - Business Phone Systems
About Yay! Terms & Conditions Privacy Policy
ISO 27001 Business Continuity Accreditation ISO 22301 Business Continuity Accreditation Cyber Essentials Certificate of Assurance G-Cloud accredited by the Crown Commercial Service
  • About Yay!
  • Terms & Conditions
  • Privacy Policy
  • Contact us
  • Frequent Questions
  • (888) YAY-8747

  • help@yay.com

  • ©2023 Yay.com

  • Yay.com - VoIP Business Phone Service Provider

26 Broadway, 8th Floor, New York, NY, 10004