Yay.com loading

Loading

SIP Account Management

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Hunt Groups

A Hunt Group is a collection of users who can be called at the same time using the groups extension number, or placed into call routes

Get your free API Key

Filter:

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

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

  • GET/voip/group

    Gets a list of all Hunt 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" : [
            {
                "name" : "Support Team",
                "extension" : 2001,
                "members" : [
                    "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
                    "cb3e4406-8e83-46e9-9048-f35e00381da1"
                ],
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-01-16",
                "updated_on" : "2017-01-16"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/group/{uuid}

    Gets the details for a specific Hunt Group on an account

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Hunt Group to be queried

    Response Details

    200 Response

    {
        "result" : {
            "name" : "Support Team",
            "extension" : 2001,
            "members" : [
                "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
                "cb3e4406-8e83-46e9-9048-f35e00381da1"
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-01-16",
            "updated_on" : "2017-01-16"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/voip/group

    Creates a new Hunt Group

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • extension

      • Integer

      • True

      The extension number assigned to this Hunt Group

      • members

      • Array of String

      • True

      A list of UUIDs of the Users in this Hunt Group

      • name

      • String

      • True

      The name of this Hunt Group

    JSON all-fields example:

    {
        "name" : "Support Team",
        "extension" : 2001,
        "members" : [
            "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
            "cb3e4406-8e83-46e9-9048-f35e00381da1"
        ]
    }

    Response Details

    201 Response

    {
        "result" : {
            "name" : "Support Team",
            "extension" : 2001,
            "members" : [
                "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
                "cb3e4406-8e83-46e9-9048-f35e00381da1"
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-01-16"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • PUT/voip/group/{uuid}

    Updates the specified Hunt Group

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Hunt Group to be updated

    PUT body

    • Name

    • Type

    • Required

      • extension

      • Integer

      • True

      The extension number assigned to this Hunt Group

      • members

      • Array of String

      • True

      A list of UUIDs of the Users in this Hunt Group

      • name

      • String

      • True

      The name of this Hunt Group

    JSON all-fields example:

    {
        "name" : "Support Team",
        "extension" : 2001,
        "members" : [
            "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
            "cb3e4406-8e83-46e9-9048-f35e00381da1"
        ]
    }

    Response Details

    200 Response

    {
        "result" : {
            "name" : "Support Team",
            "extension" : 2001,
            "members" : [
                "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
                "cb3e4406-8e83-46e9-9048-f35e00381da1"
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-01-16",
            "updated_on" : "2017-01-16"
        },
        "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/group/{uuid}

    Deletes the specified Hunt Group

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Hunt Group 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"
    }