LabelService

CallFire has a new API!

We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.

LabelService

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. 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

Delete label identified by name. All broadcasts and numbers currently containing the label will have the label association removed.

QueryLabels

Returns all defined labels

Return 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

Label broadcast (Voice, Text, or IVR) by specifying broadcastId and label name. If label name doesn't currently exist on system it will be created and saved.

UnlabelBroadcast

Removes a label from a single broadcast

Remove label from broadcast. This doesn't remove label from system, it just removes association between broadcast and label.

LabelNumber

Adds a label to a single number

Label number by specifying E.164 11 digit number identifier and label name. If label name doesn't currently exist on system it will be created and saved.

UnlabelNumber

Removes a label from a single number

Remove label from number. This doesn't remove label from system, it just removes association between number and label.