643 matches
28 actions
The SureVoIP RESTful
28 actions
- Add a new announcement audio filePOSTv1.0.0
- Create charges for invoicesPOSTv1.0.0
- Create phone calls with or without announcements and scheduled hangupsPOSTv1.0.0
- Delete an announcement audio fileDELETEv1.0.0
- List all account credit topupsGETv1.0.0
- List all customers or find your own accountGETv1.0.0
- List all Service Status messagesGETv1.0.0
- List all SIP accountsGETv1.0.0
- List areacodesGETv1.0.0
- List available SureVoIP Ofcom number allocations for purchaseGETv1.0.0
- List chargesGETv1.0.0
- List contactsGETv1.0.0
- List global announcementsGETv1.0.0
- List global billing detailGETv1.0.0
- List global ongoing faxesGETv1.0.0
- List global resourcesGETv1.0.0
- List Hosted VoIP domainsGETv1.0.0
- List mobile accountsGETv1.0.0
- List of announcement audio filesGETv1.0.0
- List ported numbersGETv1.0.0
- List SMSGETv1.0.0
- List SureVoIP Partner accountsGETv1.0.0
- Represents a customerGETv1.0.0
- Represents an announcement audio fileGETv1.0.0
- Return the IP address from where your API request originatedGETv1.0.0
- Return your POSTed data for testingPOSTv1.0.0
- Search available numbers by areacodeGETv1.0.0
- Validate a phone number by calling it onceGETv1.0.0
Other/The SureVoIP RESTful
Create phone calls with or without announcements and scheduled hangups
v1.0.0Input
- 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
{
"type": "object",
"required": [
"caller_id",
"from",
"to"
],
"properties": {
"announcement_at": {
"type": "string",
"description": "is in seconds. Just take 120 secs away from the hangup_at time for a announcement to be played 2 mins before the end of the call. If provided announcement_id is required\n"
},
"announcement_id": {
"type": "string",
"description": "is the announcement id (from https://api.surevoip.co.uk/customers/{customer}/announcements/{announcement_id}) to play for example “your call is about to end in 2 mins”. We only allow a wav file, but we may allow \"words\", which will use SureVoIP provided text to speech. If provided announcement_at is required\n"
},
"caller_id": {
"type": "string",
"description": "The caller ID to show the b leg (to)."
},
"from": {
"type": "string",
"description": "The person making the call, i.e the a leg. This person must answer in order for the b leg to be rung"
},
"hangup_announcement_id": {
"type": "string",
"description": "the id of a thank you announcement or similar. You can manage these as you would with any RESTful resource at https://api.surevoip.co.uk/announcements and https://api.surevoip.co.uk/customers/{customer}/announcements/{announcement_id}. It will be played at the end of the call at hangup. If provided hangup_at is required.\n"
},
"hangup_at": {
"type": "string",
"description": "length in seconds from when the call is *answered* to when the system hangs up. If \"hangup_announcement_id\" is present, this will be played at hangup\n"
},
"options": {
"type": "object",
"properties": {
"a_leg_caller_id": {
"type": "string",
"description": "Change the caller ID shown to the a leg (from)"
},
"a_leg_only": {
"type": "integer",
"description": "Do not ring the \"to\" number, only the from and show \"caller_id\""
},
"cancel_key": {
"type": "integer",
"description": "The phone keypad number to press to hangup the call and not place the second leg of the call. Default 2"
},
"connect_key": {
"type": "integer",
"description": "The phone keypad number to press in order to place the call to the b leg, i.e. press to confirm. Default 1"
},
"play_audio": {
"type": "array",
"items": {
"type": "object",
"properties": {
"announcement_id": {
"type": "string",
"description": "Id of announcement audio file which will play to the a leg of the call, i.e. the person that must answer the call first. This plays one or more audio files you have uploaded. The use case being you want to play audio to let the a leg of the call know what the call is about. Imagine a call center agent needs to know that they are calling a customer. These audio files may play a customer account number to the agent for example. \nHave lots of audio files in this array to build up a message\n"
}
}
}
}
}
},
"to": {
"type": "string",
"description": "The b leg of the call, i.e. the person you are calling"
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
{
"type": "object",
"properties": {
"Call": {
"type": "string"
},
"Location": {
"type": "string"
}
}
}