Yay.com loading

Loading

Error Sorry

0

Shopping Basket

Basket Total

$0.00

incVAT

Delete everything from your basket?

Go to Checkout

Queue Notices

Queue Notices define the messages that a caller hears while waiting in the queue

Become a Reseller

Filter:

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

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

  • GET/voip/queue-hint

    Gets all active queue notices 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" : [
            {
                "audios" : [
                    {
                        "files" : [
                            "position",
                            "00001111-2233-4567-8888-999999999999"
                        ],
                        "waiting_time" : 120
                    }
                ],
                "created_on" : "2019-05-27",
                "frequency" : 20,
                "name" : "Queue Position Notice",
                "updated_on" : "2019-05-27",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }
  • GET/voip/queue-hint/{uuid}

    Gets the details for a specific queue notice 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" : {
            "audios" : [
                {
                    "files" : [
                        "position",
                        "00001111-2233-4567-8888-999999999999"
                    ],
                    "waiting_time" : 120
                }
            ],
            "created_on" : "2019-05-27",
            "frequency" : 20,
            "name" : "Queue Position Notice",
            "updated_on" : "2019-05-27",
            "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"
    }
  • POST/voip/queue-hint

    Creates a new queue notice

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • audios

      • Array of Audios

      • True

      A list of the audio notices to be played

      • frequency

      • Integer

      • True

      How often the notices will be played in seconds

      • name

      • String

      • True

      The Nickname for this Queue Notice

    Audios

    Audios describe the sounds to be played to a caller, and then they should be played

      • files

      • Array of String

      • True

      An ordered list of the sound files to play to the caller. These are either a sound uuid, or one of: 'position', 'people_before', 'average_waiting_time'

      • waiting_time

      • Integer

      • True

      This message will only be played after this much time has passed

    JSON all-fields example:

    {
        "audios" : [
            {
                "files" : [
                    "position",
                    "00001111-2233-4567-8888-999999999999"
                ],
                "waiting_time" : 120
            }
        ],
        "frequency" : 20,
        "name" : "Queue Position Notice"
    }

    Response Details

    201 Response

    {
        "result" : {
            "audios" : [
                {
                    "files" : [
                        "position",
                        "00001111-2233-4567-8888-999999999999"
                    ],
                    "waiting_time" : 120
                }
            ],
            "created_on" : "2019-05-27",
            "frequency" : 20,
            "name" : "Queue Position Notice",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }
  • PUT/voip/queue-hint/{uuid}

    Updates the specified queue notice

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    PUT body

    • Name

    • Type

    • Required

      • audios

      • Array of Audios

      • True

      A list of the audio notices to be played

      • frequency

      • Integer

      • True

      How often the notices will be played in seconds

      • name

      • String

      • True

      The Nickname for this Queue Notice

    Audios

    Audios describe the sounds to be played to a caller, and then they should be played

      • files

      • Array of String

      • True

      An ordered list of the sound files to play to the caller. These are either a sound uuid, or one of: 'position', 'people_before', 'average_waiting_time'

      • waiting_time

      • Integer

      • True

      This message will only be played after this much time has passed

    JSON all-fields example:

    {
        "audios" : [
            {
                "files" : [
                    "position",
                    "00001111-2233-4567-8888-999999999999"
                ],
                "waiting_time" : 120
            }
        ],
        "frequency" : 20,
        "name" : "Queue Position Notice"
    }

    Response Details

    200 Response

    {
        "result" : {
            "audios" : [
                {
                    "files" : [
                        "position",
                        "00001111-2233-4567-8888-999999999999"
                    ],
                    "waiting_time" : 120
                }
            ],
            "created_on" : "2019-05-27",
            "frequency" : 20,
            "name" : "Queue Position Notice",
            "updated_on" : "2019-05-27",
            "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"
    }
  • DELETE/voip/queue-hint/{uuid}

    Deletes the specified queue notice

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    204 Response

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

    400 Response

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

    404 Response

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