samples.v1.1.callfire-broadcast.json Maven / Gradle / Ivy
{
"apiVersion": 1.1,
"swaggerVersion": 1.1,
"basePath": "https://www.callfire.com/api/1.1/rest",
"resourcePath": "/broadcast",
"apis": [
{
"path": "/broadcast",
"description": "Creates a new Broadcast",
"operations": [
{
"httpMethod": "POST",
"nickname": "CreateBroadcast",
"responseClass": "void",
"summary": "Creates a new Broadcast",
"notes": "This operation creates a Broadcast campaign and returns a broadcastId. To see the status of this campaign call GetBroadcast with the returned broadcastId.
There are 3 types of Broadcast: TEXT, IVR, or VOICE. Select the appropriate config to match the broadcast type, TextBroadcastConfig, IvrBroadcastConfig, or VoiceBroadcastConfig. Prefer the Text Service operations (ex: SendText) and Call Service operations (ex: SendCall) over this operation when managing simple text and call campaigns since those operations are simpler and more concise.
",
"parameters": [
{
"paramType": "form",
"name": "RequestId",
"description": "Unique ID of web request to de-dup on",
"dataType": "anyURI"
},
{
"paramType": "form",
"name": "Name",
"description": "Name of Broadcast",
"dataType": "string",
"required": true
},
{
"paramType": "form",
"name": "Type",
"description": "Type of Broadcast",
"dataType": "BroadcastType",
"allowableValues": {
"valueType": "LIST",
"values": [
"VOICE",
"IVR",
"TEXT"
]
}
},
{
"paramType": "form",
"name": "From",
"description": "E.164 11 digit number or short code",
"dataType": "PhoneNumber",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictBegin",
"description": "Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictEnd",
"description": "Latest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MaxAttempts",
"description": "Max attempts to retry broadcast (default: 1)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MinutesBetweenAttempts",
"description": "Minutes between broadcast attempts (default: 60)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "RetryResults",
"description": "Conditions to retry on",
"dataType": "Result",
"allowableValues": {
"valueType": "LIST",
"values": [
"LA",
"AM",
"BUSY",
"DNC",
"XFER",
"XFER_LEG",
"NO_ANS",
"UNDIALED",
"SENT",
"RECEIVED",
"DNT",
"TOO_BIG",
"INTERNAL_ERROR",
"CARRIER_ERROR",
"CARRIER_TEMP_ERROR"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "RetryPhoneTypes",
"description": "Phone types to call in retry",
"dataType": "RetryPhoneType",
"allowableValues": {
"valueType": "LIST",
"values": [
"FIRST_NUMBER",
"HOME_PHONE",
"WORK_PHONE",
"MOBILE_PHONE"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "AnsweringMachineConfig",
"description": "Action to take if machine answers",
"dataType": "AnsweringMachineConfig",
"allowableValues": {
"valueType": "LIST",
"values": [
"AM_ONLY",
"AM_AND_LIVE",
"LIVE_WITH_AMD",
"LIVE_IMMEDIATE"
]
},
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LiveSoundText",
"description": null,
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LiveSoundId",
"description": "ID of Sound to play if call answered by live person",
"dataType": "long",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LiveSoundTextVoice",
"description": null,
"dataType": "Voice",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MachineSoundText",
"description": null,
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MachineSoundId",
"description": "ID of Sound to play if call answered by machine",
"dataType": "long",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MachineSoundTextVoice",
"description": null,
"dataType": "Voice",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferSoundText",
"description": null,
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferSoundId",
"description": "ID of Sound to play if call transfered",
"dataType": "long",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferSoundTextVoice",
"description": null,
"dataType": "Voice",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferDigit",
"description": "Phone digit call transfers on if pressed",
"dataType": "PhoneDigit",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferNumber",
"description": "Number to transfer call to",
"dataType": "PhoneNumber",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "DncSoundText",
"description": null,
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "DncSoundId",
"description": "Do Not Call unique ID of sound",
"dataType": "long",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "DncSoundTextVoice",
"description": null,
"dataType": "Voice",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "DncDigit",
"description": "Do Not Call Digit",
"dataType": "PhoneDigit",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MaxActiveTransfers",
"description": "Max Transfers",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "From",
"description": "E.164 11 digit number or short code",
"dataType": "PhoneNumber",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictBegin",
"description": "Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictEnd",
"description": "Latest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "MaxAttempts",
"description": "Max attempts to retry broadcast (default: 1)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "MinutesBetweenAttempts",
"description": "Minutes between broadcast attempts (default: 60)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "RetryResults",
"description": "Conditions to retry on",
"dataType": "Result",
"allowableValues": {
"valueType": "LIST",
"values": [
"LA",
"AM",
"BUSY",
"DNC",
"XFER",
"XFER_LEG",
"NO_ANS",
"UNDIALED",
"SENT",
"RECEIVED",
"DNT",
"TOO_BIG",
"INTERNAL_ERROR",
"CARRIER_ERROR",
"CARRIER_TEMP_ERROR"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "RetryPhoneTypes",
"description": "Phone types to call in retry",
"dataType": "RetryPhoneType",
"allowableValues": {
"valueType": "LIST",
"values": [
"FIRST_NUMBER",
"HOME_PHONE",
"WORK_PHONE",
"MOBILE_PHONE"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "Message",
"description": "160 char or less message to be sent in text broadcast. Use rented 'keyword' in message if need response",
"dataType": "string",
"required": true,
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "BigMessageStrategy",
"description": "Set strategy if message is over 160 chars (default: SEND_MULTIPLE)",
"dataType": "BigMessageStrategy",
"allowableValues": {
"valueType": "LIST",
"values": [
"SEND_MULTIPLE",
"DO_NOT_SEND",
"TRIM"
]
},
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "From",
"description": "E.164 11 digit number or short code",
"dataType": "PhoneNumber",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictBegin",
"description": "Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictEnd",
"description": "Latest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "MaxAttempts",
"description": "Max attempts to retry broadcast (default: 1)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "MinutesBetweenAttempts",
"description": "Minutes between broadcast attempts (default: 60)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "RetryResults",
"description": "Conditions to retry on",
"dataType": "Result",
"allowableValues": {
"valueType": "LIST",
"values": [
"LA",
"AM",
"BUSY",
"DNC",
"XFER",
"XFER_LEG",
"NO_ANS",
"UNDIALED",
"SENT",
"RECEIVED",
"DNT",
"TOO_BIG",
"INTERNAL_ERROR",
"CARRIER_ERROR",
"CARRIER_TEMP_ERROR"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "RetryPhoneTypes",
"description": "Phone types to call in retry",
"dataType": "RetryPhoneType",
"allowableValues": {
"valueType": "LIST",
"values": [
"FIRST_NUMBER",
"HOME_PHONE",
"WORK_PHONE",
"MOBILE_PHONE"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "body",
"name": "DialplanXml",
"description": "IVR xml document describing dialplan",
"dataType": "file",
"required": true,
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
}
]
}
]
},
{
"path": "/broadcast",
"description": "Lists existing Broadcasts",
"operations": [
{
"httpMethod": "GET",
"nickname": "QueryBroadcasts",
"responseClass": "void",
"summary": "Lists existing Broadcasts",
"notes": "Use this operation to see the status of Broadcasts in account. Filter by type of campaign whether currently running. Returns a list of Broadcast info such as campaign name, type, status, ect...
",
"parameters": [
{
"paramType": "query",
"name": "MaxResults",
"description": "Max number of results to return limited to 1000 (default: 1000)",
"dataType": "long"
},
{
"paramType": "query",
"name": "FirstResult",
"description": "Start of next result set (default: 0)",
"dataType": "long"
},
{
"paramType": "query",
"name": "Type",
"description": null,
"dataType": "BroadcastType",
"allowableValues": {
"valueType": "LIST",
"values": [
"VOICE",
"IVR",
"TEXT"
]
},
"allowMultiple": true
},
{
"paramType": "query",
"name": "Running",
"description": "Filter on running Broadcasts",
"dataType": "boolean"
},
{
"paramType": "query",
"name": "LabelName",
"description": "Label that result must have to be included",
"dataType": "string"
}
]
}
]
},
{
"path": "/broadcast/{Id}",
"description": "Gets a single Broadcast by ID",
"operations": [
{
"httpMethod": "GET",
"nickname": "GetBroadcast",
"responseClass": "void",
"summary": "Gets a single Broadcast by ID",
"notes": "Use ID returned from CreateBroadcast or from QueryBroadcast to retreive information on indivual Broadcast. Include info such as campaign name, type, status, ect...
",
"parameters": [
{
"paramType": "path",
"name": "Id",
"description": "Unique ID of resource",
"dataType": "long",
"required": true
}
]
}
]
},
{
"path": "/broadcast/{id}",
"description": "Updates an existing Broadcast's configuration",
"operations": [
{
"httpMethod": "PUT",
"nickname": "UpdateBroadcast",
"responseClass": "void",
"summary": "Updates an existing Broadcast's configuration",
"notes": "Update existing broadcast's configuration such as time zone restrictions or retry logic. Currently all fields from config are updated so the 'Message' field needs to be populated just like in CreateBroadcast operation.
Use unique ID to specify broadcast. Need to provide dummy 'Name' field Broadcast even though the field will not be overwritten.
",
"parameters": [
{
"paramType": "form",
"name": "RequestId",
"description": "Unique ID of web request to de-dup on",
"dataType": "anyURI"
},
{
"paramType": "form",
"name": "Name",
"description": "Name of Broadcast",
"dataType": "string"
},
{
"paramType": "form",
"name": "Status",
"description": "Status of Broadcast (response only)",
"dataType": "BroadcastStatus",
"allowableValues": {
"valueType": "LIST",
"values": [
"START_PENDING",
"RUNNING",
"STOPPED",
"FINISHED",
"ARCHIVED"
]
}
},
{
"paramType": "form",
"name": "LastModified",
"description": "Last Modified 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'",
"dataType": "dateTime"
},
{
"paramType": "form",
"name": "Type",
"description": "Type of Broadcast",
"dataType": "BroadcastType",
"allowableValues": {
"valueType": "LIST",
"values": [
"VOICE",
"IVR",
"TEXT"
]
}
},
{
"paramType": "form",
"name": "Created",
"description": "DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'",
"dataType": "dateTime",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "From",
"description": "E.164 11 digit number or short code",
"dataType": "PhoneNumber",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictBegin",
"description": "Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictEnd",
"description": "Latest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MaxAttempts",
"description": "Max attempts to retry broadcast (default: 1)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MinutesBetweenAttempts",
"description": "Minutes between broadcast attempts (default: 60)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "RetryResults",
"description": "Conditions to retry on",
"dataType": "Result",
"allowableValues": {
"valueType": "LIST",
"values": [
"LA",
"AM",
"BUSY",
"DNC",
"XFER",
"XFER_LEG",
"NO_ANS",
"UNDIALED",
"SENT",
"RECEIVED",
"DNT",
"TOO_BIG",
"INTERNAL_ERROR",
"CARRIER_ERROR",
"CARRIER_TEMP_ERROR"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "RetryPhoneTypes",
"description": "Phone types to call in retry",
"dataType": "RetryPhoneType",
"allowableValues": {
"valueType": "LIST",
"values": [
"FIRST_NUMBER",
"HOME_PHONE",
"WORK_PHONE",
"MOBILE_PHONE"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "AnsweringMachineConfig",
"description": "Action to take if machine answers",
"dataType": "AnsweringMachineConfig",
"allowableValues": {
"valueType": "LIST",
"values": [
"AM_ONLY",
"AM_AND_LIVE",
"LIVE_WITH_AMD",
"LIVE_IMMEDIATE"
]
},
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LiveSoundText",
"description": null,
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LiveSoundId",
"description": "ID of Sound to play if call answered by live person",
"dataType": "long",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "LiveSoundTextVoice",
"description": null,
"dataType": "Voice",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MachineSoundText",
"description": null,
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MachineSoundId",
"description": "ID of Sound to play if call answered by machine",
"dataType": "long",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MachineSoundTextVoice",
"description": null,
"dataType": "Voice",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferSoundText",
"description": null,
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferSoundId",
"description": "ID of Sound to play if call transfered",
"dataType": "long",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferSoundTextVoice",
"description": null,
"dataType": "Voice",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferDigit",
"description": "Phone digit call transfers on if pressed",
"dataType": "PhoneDigit",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "TransferNumber",
"description": "Number to transfer call to",
"dataType": "PhoneNumber",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "DncSoundText",
"description": null,
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "DncSoundId",
"description": "Do Not Call unique ID of sound",
"dataType": "long",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "DncSoundTextVoice",
"description": null,
"dataType": "Voice",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "DncDigit",
"description": "Do Not Call Digit",
"dataType": "PhoneDigit",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "MaxActiveTransfers",
"description": "Max Transfers",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "VOICE"
}
]
},
{
"paramType": "form",
"name": "Created",
"description": "DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'",
"dataType": "dateTime",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "From",
"description": "E.164 11 digit number or short code",
"dataType": "PhoneNumber",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictBegin",
"description": "Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictEnd",
"description": "Latest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "MaxAttempts",
"description": "Max attempts to retry broadcast (default: 1)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "MinutesBetweenAttempts",
"description": "Minutes between broadcast attempts (default: 60)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "RetryResults",
"description": "Conditions to retry on",
"dataType": "Result",
"allowableValues": {
"valueType": "LIST",
"values": [
"LA",
"AM",
"BUSY",
"DNC",
"XFER",
"XFER_LEG",
"NO_ANS",
"UNDIALED",
"SENT",
"RECEIVED",
"DNT",
"TOO_BIG",
"INTERNAL_ERROR",
"CARRIER_ERROR",
"CARRIER_TEMP_ERROR"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "RetryPhoneTypes",
"description": "Phone types to call in retry",
"dataType": "RetryPhoneType",
"allowableValues": {
"valueType": "LIST",
"values": [
"FIRST_NUMBER",
"HOME_PHONE",
"WORK_PHONE",
"MOBILE_PHONE"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "Message",
"description": "160 char or less message to be sent in text broadcast. Use rented 'keyword' in message if need response",
"dataType": "string",
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "BigMessageStrategy",
"description": "Set strategy if message is over 160 chars (default: SEND_MULTIPLE)",
"dataType": "BigMessageStrategy",
"allowableValues": {
"valueType": "LIST",
"values": [
"SEND_MULTIPLE",
"DO_NOT_SEND",
"TRIM"
]
},
"conditions": [
{
"field": "Type",
"value": "TEXT"
}
]
},
{
"paramType": "form",
"name": "Created",
"description": "DateTime Broadcast was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]'",
"dataType": "dateTime",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "From",
"description": "E.164 11 digit number or short code",
"dataType": "PhoneNumber",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictBegin",
"description": "Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "LocalRestrictEnd",
"description": "Latest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "MaxAttempts",
"description": "Max attempts to retry broadcast (default: 1)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "MinutesBetweenAttempts",
"description": "Minutes between broadcast attempts (default: 60)",
"dataType": "int",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "RetryResults",
"description": "Conditions to retry on",
"dataType": "Result",
"allowableValues": {
"valueType": "LIST",
"values": [
"LA",
"AM",
"BUSY",
"DNC",
"XFER",
"XFER_LEG",
"NO_ANS",
"UNDIALED",
"SENT",
"RECEIVED",
"DNT",
"TOO_BIG",
"INTERNAL_ERROR",
"CARRIER_ERROR",
"CARRIER_TEMP_ERROR"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "RetryPhoneTypes",
"description": "Phone types to call in retry",
"dataType": "RetryPhoneType",
"allowableValues": {
"valueType": "LIST",
"values": [
"FIRST_NUMBER",
"HOME_PHONE",
"WORK_PHONE",
"MOBILE_PHONE"
]
},
"allowMultiple": true,
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "body",
"name": "DialplanXml",
"description": "IVR xml document describing dialplan",
"dataType": "file",
"conditions": [
{
"field": "Type",
"value": "IVR"
}
]
},
{
"paramType": "form",
"name": "Broadcast[id]",
"description": "Unique ID of Broadcast",
"dataType": "long"
}
]
}
]
},
{
"path": "/broadcast/{Id}/stats",
"description": "Gets performance and result statistics for a Broadcast",
"operations": [
{
"httpMethod": "GET",
"nickname": "GetBroadcastStats",
"responseClass": "void",
"summary": "Gets performance and result statistics for a Broadcast",
"notes": "Get broadcast stats by broadcastId or by interval range. Stats include information like billed amount, billed duration, actions count, attempt count, etc...
",
"parameters": [
{
"paramType": "path",
"name": "Id",
"description": "Unique ID of resource",
"dataType": "long",
"required": true
},
{
"paramType": "query",
"name": "IntervalBegin",
"description": "Beginning of DateTime interval to search on",
"dataType": "dateTime"
},
{
"paramType": "query",
"name": "IntervalEnd",
"description": "End of DateTime interval to search on",
"dataType": "dateTime"
}
]
}
]
},
{
"path": "/broadcast/{Id}/control",
"description": "Starts, Stops or Archives a Broadcast",
"operations": [
{
"httpMethod": "PUT",
"nickname": "ControlBroadcast",
"responseClass": "void",
"summary": "Starts, Stops or Archives a Broadcast",
"notes": "Apply command START, STOP, or ARCHIVE to Broadcast. Also can change the max active count of Broadcast.
",
"parameters": [
{
"paramType": "path",
"name": "Id",
"description": "Unique ID of resource",
"dataType": "long",
"required": true
},
{
"paramType": "form",
"name": "RequestId",
"description": null,
"dataType": "anyURI"
},
{
"paramType": "form",
"name": "Command",
"description": null,
"dataType": "BroadcastCommand",
"allowableValues": {
"valueType": "LIST",
"values": [
"START",
"STOP",
"ARCHIVE"
]
}
},
{
"paramType": "form",
"name": "MaxActive",
"description": "Max simultaneous calls",
"dataType": "int"
}
]
}
]
},
{
"path": "/broadcast/{BroadcastId}/batch",
"description": "Creates a new ContactBatch",
"operations": [
{
"httpMethod": "POST",
"nickname": "CreateContactBatch",
"responseClass": "void",
"summary": "Creates a new ContactBatch",
"notes": "Contact Batch is a list of contacts to associate with a broadcast. Use this operation to attach a list of contacts to an existing Campaign. A list of ToNumbers or an existing Contact List ID is required to create and attach the Contact List. Returned is the unique contactListId that can be used in ControlContactBatch to enable or disable this batch.
",
"parameters": [
{
"paramType": "form",
"name": "RequestId",
"description": null,
"dataType": "anyURI"
},
{
"paramType": "path",
"name": "BroadcastId",
"description": "Id of Broadcast",
"dataType": "long",
"required": true
},
{
"paramType": "form",
"name": "Name",
"description": null,
"dataType": "string"
},
{
"paramType": "form",
"name": "To",
"description": "List of E.164 11 digit numbers space or comma separated",
"dataType": "ToNumber"
},
{
"paramType": "form",
"name": "ToNumber[ClientData]",
"description": null,
"dataType": "string"
},
{
"paramType": "form",
"name": "ContactListId",
"description": null,
"dataType": "long"
},
{
"paramType": "form",
"name": "ScrubBroadcastDuplicates",
"description": null,
"dataType": "boolean"
}
]
}
]
},
{
"path": "/broadcast/{BroadcastId}/batch",
"description": "Lists a Broadcast's ContactBatch",
"operations": [
{
"httpMethod": "GET",
"nickname": "QueryContactBatches",
"responseClass": "void",
"summary": "Lists a Broadcast's ContactBatch",
"notes": "Return list of Contact Batches associated with this Broadcast. The contactBatchIds returned from this campaign can then be used to enable, disable, or delete the individual Batches.
",
"parameters": [
{
"paramType": "query",
"name": "MaxResults",
"description": "Max number of results to return limited to 1000 (default: 1000)",
"dataType": "long"
},
{
"paramType": "query",
"name": "FirstResult",
"description": "Start of next result set (default: 0)",
"dataType": "long"
},
{
"paramType": "path",
"name": "BroadcastId",
"description": "Unique ID of Broadcast",
"dataType": "long",
"required": true
}
]
}
]
},
{
"path": "/broadcast/batch/{Id}",
"description": "Gets a ContactBatch by ID",
"operations": [
{
"httpMethod": "GET",
"nickname": "GetContactBatch",
"responseClass": "void",
"summary": "Gets a ContactBatch by ID",
"notes": "Retrieve info on individual Contact Batch using contactId returned from CreateContactBatch
",
"parameters": [
{
"paramType": "path",
"name": "Id",
"description": "Unique ID of resource",
"dataType": "long",
"required": true
}
]
}
]
},
{
"path": "/broadcast/batch/{Id}/control",
"description": "Enables or Disables a Broadcast's ContactBatch",
"operations": [
{
"httpMethod": "PUT",
"nickname": "ControlContactBatch",
"responseClass": "void",
"summary": "Enables or Disables a Broadcast's ContactBatch",
"notes": "This operation provides the ability to enable or disable on a Broadcast the list of contacts associated with a ContactBatch.
",
"parameters": [
{
"paramType": "path",
"name": "Id",
"description": "Unique ID of resource",
"dataType": "long",
"required": true
},
{
"paramType": "form",
"name": "Name",
"description": null,
"dataType": "string"
},
{
"paramType": "form",
"name": "Enabled",
"description": null,
"dataType": "boolean"
}
]
}
]
},
{
"path": "/broadcast/{BroadcastId}/schedule",
"description": "Creates a new Schedule for a Broadcast",
"operations": [
{
"httpMethod": "POST",
"nickname": "CreateBroadcastSchedule",
"responseClass": "void",
"summary": "Creates a new Schedule for a Broadcast",
"notes": "Broadcast can be set to run at scheduled times a prescribed by BroadcastSchedule. Can pick start time, stop time, begin date, and day of week. Returns broadcastScheduleId that can be used in GetBroadcastSchedule and DeleteBroadcastSchedule
",
"parameters": [
{
"paramType": "form",
"name": "RequestId",
"description": null,
"dataType": "anyURI"
},
{
"paramType": "path",
"name": "BroadcastId",
"description": null,
"dataType": "long",
"required": true
},
{
"paramType": "form",
"name": "StartTimeOfDay",
"description": "Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"required": true
},
{
"paramType": "form",
"name": "StopTimeOfDay",
"description": "Latest time a client can be contacted in the timezone associated with the number's NPA/NXX",
"dataType": "time",
"required": true
},
{
"paramType": "form",
"name": "TimeZone",
"description": "Time Zone",
"dataType": "string",
"required": true
},
{
"paramType": "form",
"name": "BeginDate",
"description": "Start date of Campaign",
"dataType": "date"
},
{
"paramType": "form",
"name": "EndDate",
"description": "End date of Campaign",
"dataType": "date"
},
{
"paramType": "form",
"name": "DaysOfWeek",
"description": null,
"dataType": "DayOfWeek",
"allowableValues": {
"valueType": "LIST",
"values": [
"SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY"
]
},
"allowMultiple": true
}
]
}
]
},
{
"path": "/broadcast/{BroadcastId}/schedule",
"description": "Lists existing BroadcastSchedules",
"operations": [
{
"httpMethod": "GET",
"nickname": "QueryBroadcastSchedule",
"responseClass": "void",
"summary": "Lists existing BroadcastSchedules",
"notes": "List information about Broadcast Schedules attached to a Broadcast.
",
"parameters": [
{
"paramType": "query",
"name": "MaxResults",
"description": "Max number of results to return limited to 1000 (default: 1000)",
"dataType": "long"
},
{
"paramType": "query",
"name": "FirstResult",
"description": "Start of next result set (default: 0)",
"dataType": "long"
},
{
"paramType": "path",
"name": "BroadcastId",
"description": "Unique ID of Broadcast",
"dataType": "long",
"required": true
}
]
}
]
},
{
"path": "/broadcast/schedule/{Id}",
"description": "Gets a BroadcastSchedule by ID",
"operations": [
{
"httpMethod": "GET",
"nickname": "GetBroadcastSchedule",
"responseClass": "void",
"summary": "Gets a BroadcastSchedule by ID",
"notes": "List information about individual Broadcast Schedule attached to a Broadcast.
",
"parameters": [
{
"paramType": "path",
"name": "Id",
"description": "Unique ID of resource",
"dataType": "long",
"required": true
}
]
}
]
},
{
"path": "/broadcast/schedule/{Id}",
"description": "Deletes a BroadcastSchedule by ID",
"operations": [
{
"httpMethod": "DELETE",
"nickname": "DeleteBroadcastSchedule",
"responseClass": "void",
"summary": "Deletes a BroadcastSchedule by ID",
"notes": "Delete BroadcastSchedule associated with a Broadcast.
",
"parameters": [
{
"paramType": "path",
"name": "Id",
"description": "Unique ID of resource",
"dataType": "long",
"required": true
}
]
}
]
}
]
}