Returns a single TextBroadcast instance for a given text broadcast id
643 matches
100 actions
CallFire API Documentation
100 actions
- Add contacts to a contact listPOSTv1.0.0
- Add do not contact (dnc) numbersPOSTv1.0.0
- Add recipients to a call broadcastPOSTv1.0.0
- Add recipients to a text broadcastPOSTv1.0.0
- Add sound via callPOSTv1.0.0
- Add sound via filePOSTv1.0.0
- Add sound via text-to-speechPOSTv1.0.0
- Archive text broadcastPOSTv1.0.0
- Archive voice broadcastPOSTv1.0.0
- Check for a specific keywordGETv1.0.0
- Create a call broadcastPOSTv1.0.0
- Create a caller idPOSTv1.0.0
- Create a text broadcastPOSTv1.0.0
- Create an auto replyPOSTv1.0.0
- Create api credentialsPOSTv1.0.0
- Create contact list from filePOSTv1.0.0
- Create contact listsPOSTv1.0.0
- Create contactsPOSTv1.0.0
- Create mediaPOSTv1.0.0
- Delete a contactDELETEv1.0.0
- Delete a contact from a contact listDELETEv1.0.0
- Delete a contact listDELETEv1.0.0
- Delete a specific soundDELETEv1.0.0
- Delete an auto replyDELETEv1.0.0
- Delete api credentialsDELETEv1.0.0
- Delete contacts from a contact listDELETEv1.0.0
- Delete do not contact (dnc) number. If number contains commas treat as list of numbersDELETEv1.0.0
- Delete do not contact (dnc) numbers contained in source.DELETEv1.0.0
- Disable specified API credentialsPOSTv1.0.0
- Enable specified API credentialsPOSTv1.0.0
- Find a contact's historyGETv1.0.0
- Find a keyword by idGETv1.0.0
- Find a specific api credentialGETv1.0.0
- Find a specific auto replyGETv1.0.0
- Find a specific callGETv1.0.0
- Find a specific call broadcastGETv1.0.0
- Find a specific contactGETv1.0.0
- Find a specific contact listGETv1.0.0
- Find a specific keyword lease configGETv1.0.0
- Find a specific leaseGETv1.0.0
- Find a specific leaseGETv1.0.0
- Find a specific lease configGETv1.0.0
- Find a specific orderGETv1.0.0
- Find a specific soundGETv1.0.0
- Find a specific textGETv1.0.0
- Find a specific text broadcastGETv1.0.0
- Find account detailsGETv1.0.0
- Find api credentialsGETv1.0.0
- Find auto repliesGETv1.0.0
- Find call broadcastsGETv1.0.0
- Find caller idsGETv1.0.0
- Find callsGETv1.0.0
- Find calls in a call broadcastGETv1.0.0
- Find contact listsGETv1.0.0
- Find contactsGETv1.0.0
- Find contacts in a contact listGETv1.0.0
- Find credit usageGETv1.0.0
- Find do not contact (dnc) itemsGETv1.0.0
- Find keyword lease configsGETv1.0.0
- Find keyword leasesGETv1.0.0
- Find keywordsGETv1.0.0
- Find lease configsGETv1.0.0
- Find leasesGETv1.0.0
- Find local numbersGETv1.0.0
- Find mediaGETv1.0.0
- Find number regionsGETv1.0.0
- Find ordersGETv1.0.0
- Find plan usageGETv1.0.0
- Find soundsGETv1.0.0
- Find text broadcastsGETv1.0.0
- Find textsGETv1.0.0
- Find texts in a text broadcastGETv1.0.0
- Find tollfree numbersGETv1.0.0
- Find universal do not contacts (udnc) associated with toNumberGETv1.0.0
- Get a specific mediaGETv1.0.0
- Get call mp3 recording by nameGETv1.0.0
- Get call recording by idGETv1.0.0
- Get call recording by nameGETv1.0.0
- Get call recording in mp3 formatGETv1.0.0
- Get call recordings for a callGETv1.0.0
- Get delivery reports by ad hoc criteriaGETv1.0.0
- Get do not contact (dnc)GETv1.0.0
- Get statistics on call broadcastGETv1.0.0
- Get statistics on text broadcastGETv1.0.0
- Purchase keywordsPOSTv1.0.0
- Purchase numbersPOSTv1.0.0
- Send textsPOSTv1.0.0
- Start text broadcastPOSTv1.0.0
- Start voice broadcastPOSTv1.0.0
- Stop text broadcastPOSTv1.0.0
- Stop voice broadcastPOSTv1.0.0
- Update a call broadcastPUTv1.0.0
- Update a contactPUTv1.0.0
- Update a contact listPUTv1.0.0
- Update a keyword lease configPUTv1.0.0
- Update a leasePUTv1.0.0
- Update a leasePUTv1.0.0
- Update a lease configPUTv1.0.0
- Update a text broadcastPUTv1.0.0
- Update an individual do not contact (dnc) numberPUTv1.0.0
Other/CallFire API Documentation
Find a specific text broadcast
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
{
"type": "object",
"properties": {
"fields": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
}
},
"required": [
"id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
{
"type": "object",
"description": "A text campaign allows you to send a text message to a number of recipients. It supports scheduling, retry logic and pattern-based messages",
"properties": {
"bigMessageStrategy": {
"type": "string",
"description": "If message length exceeds 160 characters, multiple messages will be sent, SEND_MULTIPLE strategy is chosen by default. Available values: SEND_MULTIPLE - send text as multiple messages, DO_NOT_SEND - do not send text if it exceeds 160 characters, TRIM - trims text message to 160 characters",
"enum": [
"SEND_MULTIPLE",
"DO_NOT_SEND",
"TRIM",
"MMS"
]
},
"fromNumber": {
"type": "string",
"description": "A phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076, etc"
},
"id": {
"type": "integer",
"format": "int64",
"description": "A unique id of a broadcast"
},
"labels": {
"type": "array",
"description": "A labels of a broadcast",
"items": {
"type": "string"
}
},
"lastModified": {
"type": "integer",
"format": "int64",
"description": "A time when the given resource was updated, formatted in unix time milliseconds (read only). Example: 1473781817000"
},
"localTimeRestriction": {
"type": "object",
"description": "Represents a range of time during which CallFire will send a call or text to recipients. Timeframe uses the local timezone of recipient's number",
"properties": {
"beginHour": {
"type": "integer",
"format": "int32",
"description": "An hour of restriction start"
},
"beginMinute": {
"type": "integer",
"format": "int32",
"description": "The minutes to start a restriction"
},
"enabled": {
"type": "boolean",
"description": "A restriction enabled"
},
"endHour": {
"type": "integer",
"format": "int32",
"description": "An hour of restriction end"
},
"endMinute": {
"type": "integer",
"format": "int32",
"description": "The minutes of restriction end"
}
}
},
"maxActive": {
"type": "integer",
"format": "int32",
"description": "A maximum number of texts that CallFire dials at once"
},
"media": {
"type": "array",
"description": "~",
"items": {
"type": "object",
"description": "Represents a media file which can be added to a text message",
"properties": {
"accountId": {
"type": "integer",
"format": "int64",
"description": "~"
},
"created": {
"type": "integer",
"format": "int64",
"description": "The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 "
},
"id": {
"type": "integer",
"format": "int64",
"description": "An id of a media file"
},
"lengthInBytes": {
"type": "integer",
"format": "int64",
"description": "A size of a media file in bytes"
},
"mediaType": {
"type": "string",
"description": "A MIME type of media file, ex: image/jpeg, image/png, video/mp4, audio/mp3, etc"
},
"name": {
"type": "string",
"description": "A name of a media file"
},
"publicUrl": {
"type": "string",
"description": "A public URL of a media file"
}
}
}
},
"message": {
"type": "string",
"description": "A text message"
},
"name": {
"type": "string",
"description": "A name of a broadcast"
},
"recipients": {
"type": "array",
"description": "Recipients of a text campaign, can be an existing contacts or a new one",
"items": {
"type": "object",
"description": "A recipient of a text message. You should provide either phone number or contact id of existing contact",
"properties": {
"attributes": {
"type": "object",
"description": "A map of string attributes associated with a recipient"
},
"contactId": {
"type": "integer",
"format": "int64",
"description": "An id of existing contact in account"
},
"fromNumber": {
"type": "string",
"description": "~"
},
"media": {
"type": "array",
"description": "A list of media objects' ids associated with a text message",
"items": {
"type": "object",
"description": "Represents a media file which can be added to a text message",
"properties": {
"accountId": {
"type": "integer",
"format": "int64",
"description": "~"
},
"created": {
"type": "integer",
"format": "int64",
"description": "The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 "
},
"id": {
"type": "integer",
"format": "int64",
"description": "An id of a media file"
},
"lengthInBytes": {
"type": "integer",
"format": "int64",
"description": "A size of a media file in bytes"
},
"mediaType": {
"type": "string",
"description": "A MIME type of media file, ex: image/jpeg, image/png, video/mp4, audio/mp3, etc"
},
"name": {
"type": "string",
"description": "A name of a media file"
},
"publicUrl": {
"type": "string",
"description": "A public URL of a media file"
}
}
}
},
"message": {
"type": "string",
"description": "A text message"
},
"phoneNumber": {
"type": "string",
"description": "Phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076"
}
}
}
},
"resumeNextDay": {
"type": "boolean",
"description": "~"
},
"schedules": {
"type": "array",
"description": "~",
"items": {
"type": "object",
"description": "A campaign schedule",
"properties": {
"campaignId": {
"type": "integer",
"format": "int64",
"description": "~"
},
"daysOfWeek": {
"type": "array",
"description": "~",
"items": {
"type": "string"
}
},
"id": {
"type": "integer",
"format": "int64",
"description": "~"
},
"startDate": {
"type": "object",
"description": "Represents a date object (without time part)",
"properties": {
"day": {
"type": "integer",
"format": "int32",
"description": "A day of the month. Available values: 1-31"
},
"month": {
"type": "integer",
"format": "int32",
"description": "A month of the year. Available values: 1-12"
},
"year": {
"type": "integer",
"format": "int32",
"description": "A year. Example: 2020"
}
}
},
"startTimeOfDay": {
"type": "object",
"description": "Represents a time part of a given date",
"properties": {
"hour": {
"type": "integer",
"format": "int32",
"description": "An hour of the day. Available values: 0-23"
},
"minute": {
"type": "integer",
"format": "int32",
"description": "The minutes. Available values: 0-59"
},
"nano": {
"type": "integer",
"format": "int32",
"description": "~"
},
"second": {
"type": "integer",
"format": "int32",
"description": "The seconds. Available values: 0-59"
}
}
},
"stopDate": {
"type": "object",
"description": "Represents a date object (without time part)",
"properties": {
"day": {
"type": "integer",
"format": "int32",
"description": "A day of the month. Available values: 1-31"
},
"month": {
"type": "integer",
"format": "int32",
"description": "A month of the year. Available values: 1-12"
},
"year": {
"type": "integer",
"format": "int32",
"description": "A year. Example: 2020"
}
}
},
"stopTimeOfDay": {
"type": "object",
"description": "Represents a time part of a given date",
"properties": {
"hour": {
"type": "integer",
"format": "int32",
"description": "An hour of the day. Available values: 0-23"
},
"minute": {
"type": "integer",
"format": "int32",
"description": "The minutes. Available values: 0-59"
},
"nano": {
"type": "integer",
"format": "int32",
"description": "~"
},
"second": {
"type": "integer",
"format": "int32",
"description": "The seconds. Available values: 0-59"
}
}
},
"timeZone": {
"type": "string",
"description": "~"
}
}
}
},
"status": {
"type": "string",
"description": "A status of a broadcast. SETUP - campaign isn't configured yet; START_PENDING - waiting for contact batch population; RUNNING - campaign is running; STOPPED - campaign is stopped; FINISHED - campaign is finished; ARCHIVED - campaign was archived",
"enum": [
"TEST",
"SETUP",
"START_PENDING",
"RUNNING",
"SCHEDULED",
"STOPPED",
"SUSPENDED",
"FINISHED",
"ARCHIVED",
"VALIDATING_START",
"VALIDATING_EMAIL",
"BLOCKED_SUSPICIOUS",
"DECLINED",
"APPROVED"
]
}
}
}