{"info":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","description":"

The jambonz account-level REST API allows a user to create and manage calls, applications, speech credentials, carriers, and other resources that are associated with their account.

Authentication

The API uses Bearer authentication; i.e., a bearer token that must be provided in the Authorization header, e.g.

Authorization: Bearer 'your-api-token'

You can generate an api token for your account in the hosted portal.

HTTP response codes

POST requests will return a 201 status on success and a JSON payload that includes a sid property referencing the unique identifier of the resource that has been created.
UPDATE and DELETE requests will return a 204 status on success with no body
GET requests will return a 200 response with a JSON payload

API version

The current version of the api is v1.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8631197","collectionId":"fd9efdea-0708-4514-a34d-3230738a84cc","publishedId":"TzXzEHQd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"DA1C5C"},"publishDate":"2021-05-30T14:15:25.000Z"},"item":[{"name":"v1","item":[{"name":"Alerts","item":[{"name":"Get Alerts","id":"26b13019-d134-4e5c-8412-39d82327df60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v1/Accounts/:account_sid/Alerts?page=1&count=25&days=7","description":"

Alerts are only kept in the system for seven days. As there could be a large number of alerts, the api allows you to query pages of data at a time.

Alerts are generated when some element of your configuration is not working properly; for instance, if you have configured a webhook that is unreachable, or you try to use a speech service without having configured speech credentials.

\n","_postman_id":"0c46dc02-2280-4749-9335-2d3274c9a288","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}},{"name":"Applications","item":[{"name":"Get Applications","event":[{"listen":"test","script":{"id":"6cd28fda-6344-4c5c-afdc-7837a6255044","exec":[""],"type":"text/javascript"}}],"id":"c7a64519-bbf3-4a54-bd67-78d9a69e270e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v1/Applications","description":"

Retrieve the applications that have been created for this account

Retrieve a specific application by its unique identifier

Create an application, specifying webhook URLs and speech settings.

Success is indicated by a 201 response containing a json body with a property \"sid\" that identifies the application_sid that was created.

Update the properties of an application.

Success is indicated by a 204 response.

Deletes an application.

Success is indicated by a 204 response

\n
Note: an application can not be deleted if it is referenced by a phone number or a carrier.
\n

Applications represent the call handling rules to be applied to voice calls either made or received by the platform. Applications can be created, queried, updated, and destroyed via the API.

Applications have the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

property	description
account_sid	identifies the Account this application belongs to
application_sid	unique identifier for the application
name	user-specified name of application
call_hook	web callback to invoke for new calls
call_status_hook	web callback to invoke for call status notifications
speech_recognizer_vendor	vendor to use for speech recognition. Default: google
speech_recognizer_language	default language to use for speech recognition, if not specified in the 'gather' or 'transcribe' verbs. Default: en-US
speech_synthesis_vendor	vendor to use for text to speech. Default: google
speech_synthesis_voice	default voice to use for text to speech, if not specified in the 'say' verb. Default: en-US-Wavenet-C

","_postman_id":"268d0948-63c9-4e1b-b9db-c569ba344e39","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}},{"name":"Calls","item":[{"name":"Get Calls","id":"cf8ec6f1-a70b-40aa-a115-7a1f5da95365","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v1/Accounts/:account_sid/Calls","description":"

Retrieve a list of calls for the account that are in progress or recently ended.

\n
Note: calls that have ended more than ten minutes ago will not be returned.
\n

Retrieve information about a specific call in progress, or one that has recently ended (within the past ten minutes).

Generate an outbound call. When the call is answered, the specified webhook will be invoked to manage the call.

In this version of the createCall api you specify the application_sid identifier of the jambonz application that you want to be invoked on this call.

The following properties may be provided in the body of the request:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

option	description	required
application_sid	the application to invoke when the call is answered	yes
from	The calling party phone number.	yes
to	The destination to dial.	yes
actionHook	webhook to invoke when the call ends. The webhook will include properties describing the outcome of the call attempt.	no
amd	enable answering machine detection; see answering machine detection for details	no
confirmHook	webhook for an application to run on the callee's end after the dialed number answers but before the call is connected. This allows the caller to provide information to the dialed number, giving them the opportunity to decline the call, before they answer the call.	no
dtmfCapture	an array of strings that represent dtmf sequence which, when detected, will trigger a mid-call notification to the application via the configured `dtmfHook`	no
dtmfHook	a webhook to call when a dtmfCapture entry is matched. This is a notification only -- no response is expected, and any desired actions must be carried out via the REST updateCall API.	no
headers	an object containing arbitrary sip headers to apply to the outbound call attempt(s)	no
listen	a nested listen action, which will cause audio from the call to be streamed to a remote server over a websocket connection	no
referHook	webhook to invoke when an incoming SIP REFER is received on a dialed call. If the application wishes to accept and process the REFER, the webhook application should simply return an HTTP status code 200 with no body, and jambonz will send a SIP 202 Accepted. Otherwise, any HTTP non-success status will cause jambonz to send a SIP response to the REFER with the same status code. Note that jambonz will send the 202 Accepted and do nothing further. It is the responsibility of the third-party application to then outdial a new call and bridge the other leg, presumably by using the REST API.	no
tag	an object containing key-pairs of metadata that will be attached to this call, as per the tag verb	no
timeLimit	max length of call in seconds	no
timeout	ring no answer timeout, in seconds. Defaults to 60.	no
transcribe	a nested transcribe action, which will cause the call to be transcribed	no

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}},"urlObject":{"path":["v1","Accounts",":account_sid","Calls"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"9351f46a-678c-43f5-b8a6-d4eb58d131af","key":"account_sid"}]}},"response":[{"id":"c27b4da8-8a35-4dda-9fd8-47742330a60d","name":"Create call (version 1)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"application_sid\": \"0d27aee6-d1e6-4707-bdde-1cc20b50ca88\",\n \"from\": \"15083728399\",\n \"to\": {\n \"type\": \"phone\",\n \"number\": \"15082084809\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls"],"variable":[{"key":"account_sid","value":"9351f46a-678c-43f5-b8a6-d4eb58d131af"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 11:53:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"46"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2e-lpaoyZLqrdm4rMezbbXyEs4u/h8\""}],"cookie":[],"responseTime":null,"body":"{\n \"sid\": \"6b4931df-436a-4bfe-864e-3513d2917c02\",\n \"callId\": \"fb1893f3-b547-123c-1c99-0e24c2fb464d\"\n}"}],"_postman_id":"243a2edd-7999-41db-bd0d-08082bbab401"},{"name":"Create call (version 2)","id":"4679c8d3-8f57-4d8d-87c9-4c8351a5181d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"call_hook\": {\n \"url\": \"https://public-apps.jambonz.us/hello-world\",\n \"method\": \"POST\"\n },\n \"call_status_hook\": {\n \"url\": \"https://public-apps.jambonz.us/call-status\",\n \"method\": \"POST\"\n },\n \"from\": \"15083718299\",\n \"to\": {\n \"type\": \"phone\",\n \"number\": \"15583084809\"\n },\n \"speech_synthesis_vendor\": \"google\",\n \"speech_synthesis_language\": \"en-US\",\n \"speech_synthesis_voice\": \"Wavenet-A\",\n \"speech_recognizer_vendor\": \"Google\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/Accounts/:account_sid/Calls","description":"

In this alternative version, the webhook is explicitly provided in the payload in place of an application_sid.

Note that when an application_sid is NOT provided, you must explicitly specify the speech vendor properties in the payload (see example below).

In this alternative version, the a short form of the webhook is explicitly provided in the payload.

Note that when an application_sid is NOT provided, you must explicitly specify the speech vendor properties in the payload (see example below).

This api allows you to manipulate a call that is in progress -- i.e., \"Live Call Control\".

The actions available are:

hangup a call
mute/unmute a party on a call
pause/resume the real-time audio stream provided via the listen command
transfer one or both parties on a call to new application(s). Note that you can provide a different application for each party (e.g. queue the called party while the calling party dials a new number)
play a whisper prompt to a party.
place or remove a party that is in conference on hold.
mute/unmute all non-moderators in a conference.

Generally, a single API call can only do one of the above operations.

The JSON payload may contain the properties described in the table below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

property	description	when can this be used
call_hook	a new application to start executing on the call for the party associated with the call_sid	at any time a call is active
child_call_hook	a new application to start executing on the call for the party associated with the child_call_sid	at any time a call is active and in a dial verb
call_status	Change the status of the call. Possible values are 'completed' or 'no-answer' (the former terminates an answered call, the latter a call that is ringing)	at any time a call is in-progress or ringing
conf_hold_status	Possible values are 'hold' or 'unhold'. When playing a party on hold, a wait_hook can optionally be provided to play music or a message to the party while on hold.	Only valid when the party is in a conference.
conf_mute_status	Possible values are 'mute' or 'unmute'. Note that this action applies to all non-morderators in the conference, not to a single member	Only valid when the party is in a conference.
listen_status	Change the status of a listen stream. Possible values are 'pause' or 'resume'. Pausing a stream maintains the websocket connection but will discontinue sending audio over the connection. Resuming will start sending audio again. This may be useful, for example, when a caller is providing confidential information that you do not want to appear in a recording.	only when a listen command is active on the call (may be nested in an active dial command)
mute_status	Mute or unmute a call that is currently in a Dial verb. Possible values are 'mute' or 'unmute'. Either party in a call may be modified, depending on the call_sid provided in the path of the request-uri.	only when a dial command is currently active on a call
whisper	Play a mid-call whisper prompt to one of the parties on a call in progress. The whisper prompt is provided in a play or say verb, as shown in the examples below. The whisper may be played to either party on the call, depending on the call_sid provided in the path of the request-uri. The other party is briefly placed on hold while the prompt is played, and then reconnected to the other party afterwards.	only when a dial command is currently active on the call
wait_hook	A relative or absolute url that can be supplied when placing a party that is in conference on hold.	Only when putting a party on conference hold

The call_status, listen_status, and mute_status properties are mutually exclusive -- only one may be provided in the same request.

The whisper property may be provided alone, or together with a listen_status or mute_status property, in which case the whisper prompt is played after the listen_status or mute_status operation is complete.

Finally, if call_hook is provided, then call_status_hook may also optionally be included. This is used to specify a new callback to receive call status events.

Success is indicated by a 204 response

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}},"urlObject":{"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"host":["{{base_url}}"],"query":[],"variable":[{"type":"any","value":"9351f46a-678c-43f5-b8a6-d4eb58d131af","key":"account_sid"},{"type":"any","value":"e5f55a92-ac6c-4a2b-bbaa-5527c361fad8","key":"call_sid"}]}},"response":[{"id":"973a43ed-d43c-4873-9bf8-56f0e39facdd","name":"Hangup call","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"call_status\": \"completed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"b18382eb-ba2a-45fc-8cba-786e264904ec"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:28:24 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"},{"id":"673a413e-fdd5-4f62-b5e8-00e2a089ad59","name":"Mute party","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"mute_status\": \"mute\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"b18382eb-ba2a-45fc-8cba-786e264904ec"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:28:24 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"},{"id":"feff8c59-8bda-4df6-bfb0-6b751d065503","name":"Conference hold","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"conf_hold_status\": \"hold\",\n \"wait_hook\": \"/conference/hold\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"b18382eb-ba2a-45fc-8cba-786e264904ec"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:28:24 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"},{"id":"293efeef-1252-45a3-8133-9f79218514b5","name":"Conference mute non-moderators","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"conf_mute_status\": \"mute\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"b18382eb-ba2a-45fc-8cba-786e264904ec"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:28:24 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"},{"id":"0b22e7c0-d4b6-44af-8647-1f5c4af1327e","name":"Conference unmute non-moderators","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"conf_mute_status\": \"unmute\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"b18382eb-ba2a-45fc-8cba-786e264904ec"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:28:24 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"},{"id":"269d0394-d9c8-4ee8-abd0-aaedf99ae825","name":"Conference unhold","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"conf_hold_status\": \"unhold\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"b18382eb-ba2a-45fc-8cba-786e264904ec"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:28:24 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"},{"id":"3c3bbce7-5e1c-4e3b-a56a-8c7d79f278db","name":"Unmute party","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"mute_status\": \"mute\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"b18382eb-ba2a-45fc-8cba-786e264904ec"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:28:24 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"},{"id":"8552f2e9-b0ed-45d9-a9bc-59dd9a05365e","name":"Play whisper prompt","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\"whisper\": {\n\t\t\"verb\": \"say\",\n\t\t\"text\": \"You have two minutes remaining on your call.\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"e1577b29-3609-4d83-9ddd-8bd7f965b53c"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:34:52 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"},{"id":"d0bf844e-1ff6-4f09-b5b8-8a3bd9ab9055","name":"Transfer party to new application","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"call_hook\": \"https://public-apps.jambonz.us/hello-world\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","host":["{{base_url}}"],"path":["v1","Accounts",":account_sid","Calls",":call_sid"],"variable":[{"key":"account_sid","value":"5f8e8f60-4771-44cb-92a6-94ea66df0450"},{"key":"call_sid","value":"7b827471-94bf-4eea-9342-d174f651a4a1"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.14.2"},{"key":"Date","value":"Sun, 30 May 2021 12:38:54 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"8"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"etag","value":"W/\"8-YaBXLEiT7zQxEyDYTILfiL6oPhE\""}],"cookie":[],"responseTime":null,"body":"Accepted"}],"_postman_id":"9c80ca99-4036-4a47-8823-4609e3fd4788"},{"name":"Delete Call","id":"56905010-480e-4e00-9375-c8bc0f7d2e8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{base_url}}/v1/Accounts/:account_sid/Calls/:call_sid","description":"

Deletes a call. After this action is done, any updates / Live Call Control operations will not be possible for this call.

Success is indicated by a 204 response

\n
Note that deleting a call does not hang up the call, nor does it delete the call detail record for the call. It merely removes it from the redis database
\n

Calls that are active or recently ended (within 10 minutes) can be retrieved and managed via the api.

\n
Note: this api should not be used to retrieve call detail records. For that, please use the /RecentCalls api
\n

\n","_postman_id":"37859ad2-7b56-4a58-9dd9-8ac3005bc194","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}},{"name":"RecentCalls","item":[{"name":"Get RecentCalls","id":"4e82bdc2-327b-40a5-9b52-f86357647b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v1/Accounts/:account_sid/RecentCalls?page=1&count=25&days=7","description":"

Call detail records are only kept in the system for 30 days. As there could be a large number of CDRs, the api allows you to query pages of data at a time.

RecentCalls represent call detail records (CDRs) that are kept in the database. Currently, 30 days of CDRs are retained in the time-series database.

\n","_postman_id":"91f322f8-cbe7-427b-a604-03e9753746b5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}},{"name":"SpeechCredentials","item":[{"name":"Get SpeechCredentials","id":"baa1dc08-77bc-4d7a-8a1f-168264b287fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v1/Accounts/:account_sid/SpeechCredentials","description":"

Retrieve all SpeechCredentials associated with your account

Retrieve a single SpeechCredential

Test a SpeechCredential. This will cause the SpeechCredential to be retrieved and used in a simple text to speech and/or speech recognition request to the speech service.

\n
Note: the SpeechCredential will only be tested for TTS or STT if it is indicated as being used for that purpose.
\n

Create a SpeechCredential

Deletes a SpeechCredential.

Success is indicated by a 204 response.

SpeechCredentials represent AWS or Google tokens that are associated with your account for use in speech synthesis and recognition operations.

\n
Note: you are currently restricted to a max of two SpeechCredentials - one for AWS and one for Google
\n

\n","_postman_id":"28bcf040-830d-4e22-862f-e9de7d3b2098","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}},{"name":"VoipCarriers","item":[{"name":"Get VoipCarriers","id":"c6ebb2a7-322e-4560-90df-041afb9f4b9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v1/Accounts/:account_sid/VoipCarriers","description":"

Retrieve all VoipCarriers associated with your account

Retrieve a single VoipCarrier

Creates a new VoipCarrier that will be associated with your account

Deletes a VoipCarrier.

Success is indicated by a 204 response.

VoipCarriers represent SIP trunking providers that are associated with your account for use in placing and receiving PSTN calls.

\n","_postman_id":"d44e8e8a-bd7e-4fab-9268-89cb771535f2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}},{"name":"SipGateways","item":[{"name":"Create a SipGateway","id":"0e4858b2-57ef-4847-bda1-96551448e023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"ipv4\": \"54.172.60.2\",\n\t\"port\": \"5060\",\n\t\"inbound\": true,\n\t\"outbound\": false,\n\t\"voip_carrier_sid\": \"c10a0579-1229-4000-9a52-aa4a519a210f\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/SipGateways","description":"

Creates a new SipGateway that will be associated with a VoipCarrier

A SipGateway represents a single IP address or range of IPs that are associated with a VoipCarrier (e.g. the VoipCarrier places and receives calls from these IPs).

When you create a VoipProvider, you need to also add the SipGateways for that provider in order for incoming calls to be properly classified and for outbound calls to be properly routed.

\n","_postman_id":"370e0762-7a1e-47e3-86d5-8172563735d5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}},{"name":"Messages","item":[{"name":"Create Message","id":"54f1de57-3740-49f3-bd29-e68541d63dc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"from\": \"13053828550\",\n \"to\": \"15083084809\",\n \"text\": \"your one-time passcode is 38499\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/Accounts/:account_sid/Messages","description":"

Send an SMS. In order to send an SMS message you must have provisioned a VoipCarrier with smpp support enabled.

SMS messages can be sent if you have added a VoipCarrier that supports smpp.

\n
NOTE: this feature is currently in beta. Contact support@jambonz.org if you would like to be included in the beta testing of this feature.
\n

\n","_postman_id":"7fb2b43c-ba17-4bb5-bc68-e96427dd16da","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}}],"id":"869f821f-d264-4f97-90a8-40ea82ffdabf","description":"

The current API version is v1.

\n","_postman_id":"869f821f-d264-4f97-90a8-40ea82ffdabf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"fd9efdea-0708-4514-a34d-3230738a84cc","id":"fd9efdea-0708-4514-a34d-3230738a84cc","name":"jambonz API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"792b02a3-a3a1-4f73-b790-3b67ff1720e7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5bcccee3-2c7b-4035-968b-a3503162ab54","type":"text/javascript","exec":[""]}}]}