![\"BICS\"](\"https://www.linkpicture.com/q/logout2.png\")
\n\nBuild multi-channel reach towards your customers with our simple, programmable BICS VOICE API
\nUsing REST API, you can enable various communication use-cases
\nTurn OTP (One Time Password) or automated reminder message into speech (Text To Speech)
\nPlay an OTP audio file or an audio announcement file
\nInitiate a flash call
\nEnable Number masking – enable users to call each other without revealing their personal phone number
\nRecord Voice calls while enabling Number masking
\nCollect Call Transaction Data Records (CTDR) for each call initiated through the API
\nYou need to be authenticated to invoke VOICE API services. The authentication is based on an API key that must be passed as http header to each API service. If you don’t have an API key, you can ask a new key by contacting BICS Account Manager or by filling out the Request Api key form.
\nAll communications with the BICS API platform are performed using an encrypted (TLS) connection. Your Authentication Key is your personal identifier; it is used to enable and identify your transactions on our API platform. It is vital to keep this key securely. If you believe there is a breach or your key has leaked, please contact BICS customer support that is available 24x7 and request for key replacement.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"061566d5-1db2-4879-9184-48f45b0462a9"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3d1a59d6-a17c-4cf2-888d-62195e3c5ed7"}}],"_postman_id":"e8cde379-e7df-4485-8e14-44a4cdefa51f"},{"name":"Text To Speech","item":[{"name":"Text To Speech","id":"bcc3922b-7361-4a80-bdbc-27383008f24c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{api_key}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"textToPlay\" : \"Hello World, Today is a good day!\",\r\n\t\"destNumber\" : \"447700900204\",\r\n\t\"callingNumber\" : \"441164960484\",\r\n\t\"displayNumber\" : \"441164960484\",\r\n\t\"voiceId\" :\"Matthew\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://openvoice.api.bics.com/v1/texttospeech","description":"This API method turns a text into natural-sounding speech and play it to a given phone number (Text To Speech). The method provides a multitude of possibilities. You can customize different options like the language, the type of the voice, the speed, the volume, introducing specific breaks within text which will be read, the pitch, the emphasise and many others.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"cb55ece9-12a2-475c-8a98-2dd35ea6cbad"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"81de15df-a067-450e-a92f-b25ed7ee2b7c"}}],"_postman_id":"19494545-e138-41e5-820e-927a39380643"},{"name":"Play Announcement","item":[{"name":"Play Announcement","id":"c166a673-9a00-4c7f-b1a4-02b6ff54f0ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"fileToPlay\": \"https://apiuser.com/announcement.wav\",\n \"destNumber\": \"447700900204\",\n \"callingNumber\": \"441164960484\",\n \"displayNumber\": \"441164960484\"\n}","options":{"raw":{"language":"json"}}},"url":"https://openvoice.api.bics.com/v1/announcement","description":"This API method allows you to play an OTP audio file or an audio announcement file to a given phone number.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3fb24f3a-7176-479e-903f-6d3a361493eb"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"327a3ced-11a4-4e71-a99e-012719b6c339"}}],"_postman_id":"aeecf04b-8968-4847-9ff5-51a17755ff36"},{"name":"Number Masking","item":[],"id":"fd05e3de-0251-47b1-a03d-934b5a7ea3f1","description":"Using our Number Masking capability, you can enable users to call each other without revealing their personal phone numbers.
\nThe following diagram illustrates the call flow between caller and callee with number masking capability.
\n![](\"https://www.linkpicture.com/q/flow_number_masking.png\")
\n\nThe caller initiates a call to a predefined BICS number (1). BICS VOICE API platform sends a request to the Customer Voice System to get the anonymous phone number mapping (2). The mapping contains the callee’s phone number to which the call should be forwarded to and the anonymous phone number (3). BICS VOICE API platform calls the callee’s by displaying the anonymous phone number (4). When the callee answers the call (5), BICS VOICE API bridges the caller and the callee (6) who communicate to each other without revealing their identity (7).
\nFor more information about how to provide the instructions, please consult the API Get instructions.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"76018e10-8a52-4c4f-a4b8-3c0475e4c08b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d7676b29-8c69-4f0f-bfef-1a4b8833dd7f"}}],"_postman_id":"fd05e3de-0251-47b1-a03d-934b5a7ea3f1"},{"name":"Call recording ","item":[],"id":"d62aeb08-3f9d-42d2-b234-b96838b1cec5","description":"The BICS VOICE API platform allow you to record a call between the caller and the callee.
\nThe following diagram illustrates the call flow between caller and callee with call recording.
\n![](\"https://www.linkpicture.com/q/flow_call_recording.png\")
\n\nThe caller initiates a call to a predefined BICS number (1). BICS VOICE API platform sends a request to the Customer Voice System to get the instructions (2). The Customer Voice System returns the instruction to record the call (3). BICS VOICE API platform calls the callee (4). When the callee answers the call (5), BICS VOICE API bridges the caller and the callee (6) and starts recording the call (7). The caller and the callee communicates to each other through BICS network (8). Optionally, you can notify the users that the call is recorded with a voice announcement played at the beginning of the call. Once the call is terminated, BICS platforms stores the recording file in wav format on AWS Amazon Cloud(9). Finally, you can download the recording file (10).
\nYour recordings are accessible in just a few clicks. You can contact your Account Manager to get your Amazon S3 credentials and access your files.
\nOnce you get your credentials, you can sign in on the AWS Amazon S3 website https://aws.amazon.com/s3/. All you recordings will be listed on the AWS Amazon S3 website. You will be able to download your files or delete them at your convenience.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"da85c78f-685d-4199-be93-0074823b343d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"aa5c6a0e-b60e-43b2-9488-df0f3cbe8b97"}}],"_postman_id":"d62aeb08-3f9d-42d2-b234-b96838b1cec5"},{"name":"Initiate Call","item":[{"name":"initiate Call","id":"5bc0b2e9-1a26-4a09-a8cb-4de269e13265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"destNumber\" : \"447700900204\",\r\n\t\"callingNumber\" : \"441164960484\",\r\n\t\"displayNumber\" : \"441164960484\",\r\n\t\"callBackUrl\" :\"https://apiuser.com/instructions.html\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://openvoice.api.bics.com/v1/initiateCall","description":"Using this API, you can place a new call on a given destination number and provide the instructions that will be performed in case the recipient answers the call. BICS API platform sends a request to the \nCustomer Voice System. to get the instructions.\nAvailable instructions are call bridging, numbers masking, announcement playing and call recording. For more information, please consult the section Get instructions.
\nThe following diagram depicts the call flow for outbound calling with audio announcement play.
\n![](\"https://www.linkpicture.com/q/flow_initiate_call.png\")
\n\nThe Customer Voice System calls our API initiateCall by mentioning the destination number (1). BICS VOICE API dials the destination number (2). If the user answers the call (3), BICS Voice API sends a request to the Customer Voice System to get the instructions (4). The Customer Voice Systems returns the instructions - play announcement in this case (5) and BICS VOICE API reads the instructions and plays the announcement to the user (6).
\nAlternatively, instructions can consist of bridging the call with another user, enabling number masking, call recording or a combination of some of them.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"74cfd638-e2dd-40e1-ad14-cde6193f92c7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e9be7341-c6e5-4949-b981-94221e2b4ea7"}}],"_postman_id":"71fa970e-0520-46b5-8fa6-abde93235b22"},{"name":"Instructions","item":[{"name":"Instructions","id":"6c470b6c-2040-47a5-ac92-e4067e8c5bbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://apiuser.com/v1/instructions?destinationNumber=32123456789&callerIdNumber=32987654321","description":"As explained in Number Masking, Call Recording and Initiate Call sections, BICS VOICE API platform gets the instructions by calling the Customer Voice System. \nFor that purpose, you need to expose an API method Get Instructions that returns the instructions in accordance with a particular format. \nAvailable instructions are call bridging, numbers masking, announcement playing, call recording or a combination of some of them.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a519b377-9d3e-4c0f-8a06-f995786f0f31"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"eb60e37d-736c-4b6d-8353-1858069299b1"}}],"_postman_id":"029d2d61-216b-49aa-9cfa-ddab1bcf1eef"},{"name":"Subscription","item":[{"name":"Call Transaction Details Subscription","id":"5f975e61-2b5e-4523-97f1-b96d7c7b1e97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{api_key}}"}],"body":{"mode":"raw","raw":"{ \r\n \"url\": \"https://apiuser.com/callTransactionDataRecord\", \r\n \"securityToken\": \"r2k5hq3\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://openvoice.api.bics.com/v1/subscription","description":"By using this API, you can subscribe to BICS API platform in order to get Call Transaction Data Records (CTDRs). You need to specify the URL where CTDR should be sent at the end of each call.
\nNote: these call transaction data records should not be considered for billing purpose.
\nBy using this API, you can get the subscribed URL and security token that you have created with Create Call Details Subscription API.
\n","urlObject":{"protocol":"https","path":["v1","subscription"],"host":["openvoice","api","bics","com"],"query":[],"variable":[]}},"response":[{"id":"714cb7ab-5a0b-4cd7-93ca-ad0941e481d3","name":"Get Call Transaction Details Subscription","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{api_key}}"}],"url":"https://openvoice.api.bics.com/v1/subscription"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Mon, 08 Feb 2021 21:08:03 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Cache-Control","value":"proxy-revalidate"},{"key":"Connection","value":"close"},{"key":"Set-Cookie","value":"BCSI-CS-f5e92521aae4087c=1; Path=/"},{"key":"Proxy-support","value":"Session-based-authentication"}],"cookie":[],"responseTime":null,"body":"{ \n \"url\": \"https://www.apiuser.com/callTransactionDataRecord\", \n \"securityToken\": \"r2k5hq3\",\n}"}],"_postman_id":"444ad8f3-4db3-4242-85f0-87e597e8335a"},{"name":"Call Transaction Details Subscription","id":"b7e8396d-1c4b-49fa-9475-45e609b37d64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{api_key}}"}],"url":"https://openvoice.api.bics.com/v1/subscription","description":"By using this API, you can delete your subscription for Call Transaction Details.
\n","urlObject":{"protocol":"https","path":["v1","subscription"],"host":["openvoice","api","bics","com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"9b398b20-4ace-414a-9f98-90a86f822716","name":"Delete Call Transaction Details Subscription","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{api_key}}"}],"url":"https://openvoice.testapi.bics.com/v1/subscription"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b7e8396d-1c4b-49fa-9475-45e609b37d64"},{"name":"Call Transaction Data Record","id":"38632189-b30c-4864-9cfd-8cfc111a98b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"callID\": \"03d90a60-56de-4b13-ad6a-5cf3b3f153f3\", \r\n \"callerIdNumber\": \"123456789\",\r\n \"calleeIdNumber\": \"987654321\",\r\n \"hangupCause\": \"NORMAL_CLEARING\", \r\n \"duration\": \"9\",\r\n \"billDuration\": \"2\",\r\n \"startTime\": \"1606563428\", \r\n \"answerTime\": \"1606563437\",\r\n \"endTime\": \"1606563439\",\r\n \"securityToken\": \"r2k5hq3\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://apiuser.com/v1/callTransactionDataRecord","description":"In case you have created successfully the subscription for the call details records using above API Create Call Details Subscription, you will receive an HTTP POST request on the subscribed URL after each VOICE API call. The POST request contains the call’s details record.
\nYou can subscribe to BICS API platform to get Call Transaction Data Records (CTDRs) of each call initiated through our Voice API.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2bf1d336-1c76-4977-b074-3f028c99f5b8"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2beb3f35-53fb-47fc-aa81-b8954d50126a"}}],"_postman_id":"c1c6d4b9-9126-4273-94e5-ed1009374198"},{"name":"HTTP Response Status Codes","item":[],"id":"1f08e5fa-fea2-44bb-a8df-0cedb5044dff","description":"As you make API calls, you will see responses indicating what is happening on the other side of the server. The following is a list of common status codes you will see in response from the BICS API, and what they mean.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"35284c06-e79e-4196-8bf5-02fd8d3f218d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a63ed1f8-2ecd-4283-841f-23c4b3424c7c"}}],"_postman_id":"1f08e5fa-fea2-44bb-a8df-0cedb5044dff"}],"event":[{"listen":"prerequest","script":{"id":"8e83706b-f143-439a-be93-0c41c22c9e1e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9bf717c8-d9ec-4283-b6f8-ada401cedbc3","type":"text/javascript","exec":[""]}}]}