Returns a single NumberConfig instance for a given number lease
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 lease config
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
{
"type": "object",
"properties": {
"fields": {
"type": "string"
},
"number": {
"type": "string"
}
},
"required": [
"number"
],
"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
{
"type": "object",
"description": "Represents the configuration of a phone number purchased by user. You can configure number to accept inbound calls, play sounds to customer, make a transfer or setup an IVR script to interact with customer. See [CallFire IVR](https://www.callfire.com/products/ivr) for more info",
"properties": {
"callTrackingConfig": {
"type": "object",
"description": "Call tracking configuration allows you track incoming calls, analyze, respond to customers using sms or voice replies. For more information see [call tracking page](https://www.callfire.com/products/call-tracking)",
"properties": {
"failedTransferSoundId": {
"type": "integer",
"format": "int64",
"description": "An id of sound file, played if caller can not be connected to transfer number for any reason"
},
"googleAnalytics": {
"type": "object",
"description": "Google Analytics for Call Tracking",
"properties": {
"category": {
"type": "string",
"description": "A category to group. For example: Sales or Support"
},
"domain": {
"type": "string",
"description": "A domain name for analytics"
},
"googleAccountId": {
"type": "string",
"description": "An id of a Google account, example: UA-XXXXX-2X"
}
}
},
"introSoundId": {
"type": "integer",
"format": "int64",
"description": "An id of sound file, played if call is answered"
},
"recorded": {
"type": "boolean",
"description": "Records all inbound calls"
},
"screen": {
"type": "boolean",
"description": "Screens the incoming calls"
},
"transferNumbers": {
"type": "array",
"description": "List of phone numbers in E.164 format (11-digit) are used for transfer. Example: 12132000384",
"items": {
"type": "string"
}
},
"voicemail": {
"type": "boolean",
"description": "Enables voicemail if call is not transferred"
},
"voicemailSoundId": {
"type": "integer",
"format": "int64",
"description": "An id of sound file, played if voicemail is enabled and a call isn't transferred"
},
"weeklySchedule": {
"type": "object",
"description": "Weekly schedule allows to schedule operations by day of week and time of the day",
"properties": {
"daysOfWeek": {
"type": "array",
"description": "A scheduled days when operation will trigger",
"items": {
"type": "string"
}
},
"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"
}
}
},
"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": "A user's timezone"
}
}
},
"whisperSoundId": {
"type": "integer",
"format": "int64",
"description": "An id of sound file, played if call is screened"
}
}
},
"configType": {
"type": "string",
"description": "A type of config. Available values: TRACKING, IVR",
"enum": [
"IVR",
"TRACKING"
]
},
"ivrInboundConfig": {
"type": "object",
"description": "~",
"properties": {
"dialplanXml": {
"type": "string",
"description": "~"
}
}
},
"number": {
"type": "string",
"description": "Phone number in E.164 format (11-digit). Example: 12132000384"
},
"textInboundConfig": {
"type": "object",
"description": "~",
"properties": {
"forwardEnabled": {
"type": "boolean",
"description": "~"
},
"forwardNumber": {
"type": "string",
"description": "~"
}
}
}
}
}