Yay.com loading

Loading

Error Sorry

0

Shopping Basket

Basket Total

$0.00

incVAT

Delete everything from your basket?

Go to Checkout

Queue Groups

Queue Groups define the members who will answer a queue, and the order in which they will ring

Become a Reseller

Filter:

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

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

  • GET/voip/queue-group

    Gets all active queue groups 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" : [
            {
                "answer_wait" : 60,
                "created_on" : "2019-05-27",
                "duration" : 15,
                "max_no_answer" : 60,
                "members" : 60,
                "name" : "Helpline Queue",
                "no_answer_wait" : 60,
                "reject_wait" : 60,
                "ring_progressively" : 15,
                "ring_timeout" : 15,
                "strategy" : "ringall",
                "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-group/{uuid}

    Gets the details for a specific queue group 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" : {
            "answer_wait" : 60,
            "created_on" : "2019-05-27",
            "duration" : 15,
            "max_no_answer" : 60,
            "members" : 60,
            "name" : "Helpline Queue",
            "no_answer_wait" : 60,
            "reject_wait" : 60,
            "ring_progressively" : 15,
            "ring_timeout" : 15,
            "strategy" : "ringall",
            "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-group

    Creates a new queue group

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • answer_wait

      • Integer

      • True

      The time to wait before ringing a member again after they have answered a call

      • duration

      • Integer

      • True

      The duration in seconds the strategy will consider the stats for

      • max_no_answer

      • Integer

      • True

      If greater than 0, this is the maximum number of times a user can fail to answer a call before being set to unavailable

      • members

      • Array of String

      • True

      A list of user uuids of the members that should be included in this queue group

      • name

      • String

      • True

      The nickname for this Queue Group

      • no_answer_wait

      • Integer

      • True

      The time to wait before ringing a member again if they don't answer a call

      • reject_wait

      • Integer

      • True

      The time to wait before ringing a member again after they reject a call

      • ring_progressively

      • Boolean

      • True

      Should the previous member keep ringing when moving to the next member (if the strategy is not 'ringall')

      • ring_timeout

      • Integer

      • True

      The time in seconds to wait before ringing the next member in the group (if the strategy is not 'ringall')

      • strategy

      • String

      • True

      The ring strategy to use for this Queue Group: 'ringall', 'sequential', 'sequential_from_first', 'longestidle', 'fewestcalls', or 'leasttalkingtime'

    JSON all-fields example:

    {
        "answer_wait" : 60,
        "duration" : 15,
        "max_no_answer" : 60,
        "members" : 60,
        "name" : "Helpline Queue",
        "no_answer_wait" : 60,
        "reject_wait" : 60,
        "ring_progressively" : 15,
        "ring_timeout" : 15,
        "strategy" : "ringall"
    }

    Response Details

    201 Response

    {
        "result" : {
            "answer_wait" : 60,
            "created_on" : "2019-05-27",
            "duration" : 15,
            "max_no_answer" : 60,
            "members" : 60,
            "name" : "Helpline Queue",
            "no_answer_wait" : 60,
            "reject_wait" : 60,
            "ring_progressively" : 15,
            "ring_timeout" : 15,
            "strategy" : "ringall",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

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

    Deletes the specified queue group

    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"
    }
  • PUT/voip/queue-group/{uuid}

    Updates the specified queue group

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    PUT body

    • Name

    • Type

    • Required

      • answer_wait

      • Integer

      • True

      The time to wait before ringing a member again after they have answered a call

      • duration

      • Integer

      • True

      The duration in seconds the strategy will consider the stats for

      • max_no_answer

      • Integer

      • True

      If greater than 0, this is the maximum number of times a user can fail to answer a call before being set to unavailable

      • members

      • Array of String

      • True

      A list of user uuids of the members that should be included in this queue group

      • name

      • String

      • True

      The nickname for this Queue Group

      • no_answer_wait

      • Integer

      • True

      The time to wait before ringing a member again if they don't answer a call

      • reject_wait

      • Integer

      • True

      The time to wait before ringing a member again after they reject a call

      • ring_progressively

      • Boolean

      • True

      Should the previous member keep ringing when moving to the next member (if the strategy is not 'ringall')

      • ring_timeout

      • Integer

      • True

      The time in seconds to wait before ringing the next member in the group (if the strategy is not 'ringall')

      • strategy

      • String

      • True

      The ring strategy to use for this Queue Group: 'ringall', 'sequential', 'sequential_from_first', 'longestidle', 'fewestcalls', or 'leasttalkingtime'

    JSON all-fields example:

    {
        "answer_wait" : 60,
        "duration" : 15,
        "max_no_answer" : 60,
        "members" : 60,
        "name" : "Helpline Queue",
        "no_answer_wait" : 60,
        "reject_wait" : 60,
        "ring_progressively" : 15,
        "ring_timeout" : 15,
        "strategy" : "ringall"
    }

    Response Details

    200 Response

    {
        "result" : {
            "answer_wait" : 60,
            "created_on" : "2019-05-27",
            "duration" : 15,
            "max_no_answer" : 60,
            "members" : 60,
            "name" : "Helpline Queue",
            "no_answer_wait" : 60,
            "reject_wait" : 60,
            "ring_progressively" : 15,
            "ring_timeout" : 15,
            "strategy" : "ringall",
            "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"
    }