Fields

accountId : ID

The account ID associated with the item.

If the phone number for the item is not set, the account ID will be used to determine the phone number to call.
callWindowEnd : DateTime

Together with call_window_start, this determines the time window in which the item should be called. Specified as ISO 8601 format.
callWindowStart : DateTime

Together with call_window_end, this determines the time window in which the item should be called. Specified as ISO 8601 format.
id : ID

The ID of the campaign item.
metadata : JSONString

Metadata about the item.

This enables items to be filtered based on additional information such as location. It is a dictionary of key-value pairs, with both keys and values being strings.
phoneNumber : String

The phone number of the campaign item.

This is used to determine the phone number to call when the item is processed. If it is not set, the account ID will be used instead to call the phone number associated with the account.
status : CampaignItemStatus! required

The status of the campaign item that determines what actions can be taken on it.

"UNASSIGNED":  An item that is ready to be assigned to an agent
"ASSIGNED":    An item that is assigned to an agent and ready to contact
"IN_PROGRESS": An item where a call is currently in progress
"COMPLETE":    An item has been contacted, and does not need to be re-contacted
"REMOVED":     An item that was removed without being contacted
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountId": "43672842", "callWindowEnd": "2017-02-04T20:21:26.470545+00:00", "callWindowStart": "1995-04-05T10:41:46.386508+00:00", "id": "32545835", "metadata": {"key": "value"}, "phoneNumber": "nation-make-talk-shoulder-now", "status": "UNASSIGNED" }