Retrieving Call Tags

Retrieving All Call Tags

Using the GET method, you can retrieve all of the Call Tags configured for your account.

Retrieve All - GET https://edgeapi.marchex.io/marketingedge/v5/api/calltags

The following sample request can be used to retrieve all Call Tags. Note that the results of this request use pagination as defined in the Paging Results section of this documentation

curl -H "x-organization-token: {authorization_token}" \
 			-H "subscription-key: {subscription_key}" \
     	-X GET "https://edgeapi.marchex.io/marketingedge/v5/api/calltags"

If the request is handled successfully, the following response will be returned:

{
    "paging": {
      "pageNumber": 1,
      "pageSize": 10000,
      "total": 2
    },
    "results": [
      {
        "id": "e1566ae2-a64c-4747-9aeb-233b8495f344",
        "name": "New Callers over 15s",
        "description": "New Callers over 15s",
        "type": "auto",
        "rules": [
          {
            "rule": {
              "type": "CallerType"
            }
          },
          {
            "rule": {
              "type": "CallDuration",
              "duration": 15,
              "operand": "GreaterThanOrEqual"
            }
          }
        ]
      },
      {
        "id": "ec08934b-d250-46e7-a9e5-35945d041b5e",
        "name": "Vacation Booked",
        "description": "Vacation Booked",
        "type": "auto",
        "rules": [
          {
            "rule": {
              "type": "CallKeywords",
              "count": 2,
              "target": "Caller"
            }
          },
          {
            "rule": {
              "type": "CallerType"
            }
          }
        ]
      }
    ]
  }

Retrieving a Call Tag

Using the GET method, you can retrieve an individual Call Tag

Retrieve Individual - GET https://edgeapi.marchex.io/marketingedge/v5/api/calltag/{calltagID}

The following sample request can be used to retrieve a single Call Tag:

curl -H "x-organization-token: {authorization_token}" \
 			-H "subscription-key: {subscription_key}" \
     	-X GET \
     	"https://edgeapi.marchex.io/marketingedge/v5/api/calltag/e1566ae2-a64c-4747-9aeb-233b8495f344"

If the request is handled successfully, the following response will be returned:

{
  "id": "e1566ae2-a64c-4747-9aeb-233b8495f344",
  "name": "New Callers over 15s",
  "description": "New Callers over 15s",
  "type": "auto",
  "rules": [
    {
      "rule": {
        "type": "CallerType"
      }
    },
    {
      "rule": {
        "type": "CallDuration",
        "duration": 15,
        "operand": "GreaterThanOrEqual"
      }
    }
  ]
}

Updated about 4 years ago