CallFire Solutions

Introduction

Follow

LabelService

This service provides operations for labeling and querying objects by label. Labels allow you to organize broadcasts, numbers, calls and texts into groups that make sense for your application. You can attach labels to any of these objects by using LabelNumber or LabelBroadcast. Labels use name as their identifier instead of id.

DeleteLabel

Removes a label from all labeled objects and deletes it This operation deletes a label identified by name. All broadcasts and numbers currently containing that label will have the label association removed.

QueryLabels

Returns all defined labels This operation returns a list of all defined label names. The labels may be associated with broadcasts or numbers.

LabelBroadcast

Adds a label to a broadcast, creating the label if it doesn't already exist This operation allows labeling a broadcast (Voice, Text, or IVR) by specifying broadcastId and a label name. If the label name doesn't currently exist on the system, it will be created and saved.

UnlabelBroadcast

Removes a label from a single broadcast This operation removes a label from a broadcast. This doesn't remove the label from the system, it just removes the association between the broadcast and the label.

LabelNumber

Adds a label to a single number This operation labels a (phone) number by specifying a E.164 11 digit number identifier and label name. If the label name doesn't currently exist on the system, the system creates and saves it.

UnlabelNumber

Removes a label from a single number This operation removes a label from a number. This doesn't remove the label from the system, it just removes the association between the number and the label.

Have more questions? Submit a request

Comments