{"_id":"5613d8de6a092921004c30b8","user":"54eb4fdedf7add210007b29b","version":{"_id":"54eb63b859b1172100334fae","project":"54eb50e5615ffc1900305a16","forked_from":"54eb63a1867e1917009b711d","__v":28,"createdAt":"2015-02-23T17:30:32.501Z","releaseDate":"2015-02-23T17:30:32.501Z","categories":["54eb63b959b1172100334faf","54eb63b959b1172100334fb0","54eb63b959b1172100334fb1","54eb63b959b1172100334fb2","54ed8dd4ab373e2300f50eae","54ed99b2ab373e2300f50ede","55153a6de68daa2f00cff838","551546edbc466623002afe72","5515472ac28d6125001b8884","55154749c28d6125001b8885","555d9b4106dfec0d00d38ea7","5613e06e433e5735007c7708","5624bbb785a31117001c5403","56669e857cc81e0d00253f8e","568b8d837a42220d00498311","56a632277ef6620d00e2f18a","56d8147c3eb4dd0b00201aac","57a9ce2fac6db30e000d7efd","57a9cf4e944ea60e00dc3f74","58172386715dce0f00da4aa0","582dc59ee1b8692300c0dd03","589b19b4fec2730f0082e040","58b04a023529383900a759b5","58b92d1598157a0f004869bf","592e7685c58275000f20174f","59392839e376d4002f8a0474","59393064e376d4002f8a05a1","5947ae0d4005e2000f3a4fec","594a74df1d1de5001ab3517a","5954bc387a147f001b918915","59b8eeeb707542001076d3b6"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"project":"54eb50e5615ffc1900305a16","editedParams":true,"category":{"_id":"5624bbb785a31117001c5403","pages":["5653264657978b1700df716a","5655bcf8dd82540d00278c26","5655bfd81a06b61900c66873","5655c7c0a66be71700968dd7","5660588e4320a80d00bec124","56618ad455e4450d00e62b89","56f1685a2a85600e00ea3dca"],"project":"54eb50e5615ffc1900305a16","version":"54eb63b859b1172100334fae","__v":7,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-10-19T09:45:27.364Z","from_sync":false,"order":11,"slug":"2-factor-authentication","title":"2-factor authentication"},"parentDoc":null,"__v":3,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-06T14:21:18.074Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":true,"api":{"examples":{"codes":[{"language":"json","name":"","code":"POST /2fa/1/pin/voice HTTP/1.1\nHost: api.infobip.com\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\nContent-Type: application/json\nAccept: application/json\n\n{\n  \"applicationId\": \"HJ675435E3A6EA43432G5F37A635KJ8B\",\n  \"messageId\": \"0130269F44AFD07AEBC2FEFEB30398A0\",\n  \"from\": \"41793012321\",\n  \"to\": \"41793026727\"\n}"}]},"method":"post","results":{"codes":[{"code":"{\n  \"pinId\": \"9C817C6F8AF3D48F9FE553282AFA2B67\",\n  \"to\": \"41793026727\",\n  \"callStatus\": \"PENDING_ACCEPTED\"\n}","name":"","status":200,"language":"json"},{"code":"{\n  \"requestError\": {\n    \"serviceException\": {\n      \"messageId\": \"UNAUTHORIZED\",\n      \"text\": \"Invalid login details\"\n    }\n  }\n}","language":"json","status":401}]},"settings":"554860d6d2c8410d006c215e","auth":"required","params":[{"_id":"5613cdbeecbebc21003fa17b","ref":"","in":"body","required":true,"desc":"Phone number to which 2FA message will be delivered via voice. Must be in international format (Example: `41793026727`).","default":"","type":"string","name":"to"},{"_id":"5613cdbeecbebc21003fa17d","ref":"","in":"body","required":true,"desc":"2FA application ID.","default":"","type":"string","name":"applicationId"},{"_id":"5613cdbeecbebc21003fa17c","ref":"","in":"body","required":true,"desc":"ID of 2FA message that will be read to a phone number.","default":"","type":"string","name":"messageId"},{"_id":"5613cdbeecbebc21003fa17a","ref":"","in":"body","required":false,"desc":"Sender ID in *numeric* format. If this parameter is not set, it will be automatically filled from the created message parameter sender. If neither parameter value nor sender ID from the message is numeric, the default sender ID will be used.","default":"","type":"string","name":"from"}],"url":"/2fa/:version/pin/voice"},"isReference":true,"order":9,"body":"## Response format\n\nOn success, response header HTTP status code will be `200 OK`. \n\nOn error, you will receive an [error response status code](doc:2fa-status-codes-and-error-details) in the header and the response body will contain an [error object](doc:2fa-status-codes-and-error-details). If you try to create an application when you do not have the user’s authorization, you will receive an error `401` Unauthorized.\n\n### Response\n\n|Parameter|Type|Description|\n|-|-|-|\n|*to*|String|Phone number to which 2FA message was sent via voice.|\n|*callStatus*|String|Call status.|\n|*pinId*|String|Sent PIN code ID.|\n\n#### Call status list\n\n|Value|Description|\n|:---|:---|\n|`BAD_REQUEST`|Provided request does not meet required conditions.|\n|`PROCESSING`|Request is currently being processed.|\n|`PROCESSED`|Request is successfully processed and answered by human.|\n|`ANSWERED_MACHINE`|Request is successfully processed and answered by machine.|\n|`ERROR`|System error occurred during processing.|\n|`ERROR_NOT_ENOUGH_CREDITS`|Not enough credits on account balance to pay for the call.|\n|`ERROR_NETWORK_NOT_AVAILABLE`|We could not find network for given destination address.|\n|`ERROR_ROUTE_NOT_AVAILABLE`|Route for TTS call is not set up on account.|\n|`ERROR_USER_BUSY`|User was busy during call attempt(s).|\n|`ERROR_NO_ANSWER`|User did not answer call(s).|\n|`UNDEFINED`|Request is undefined.|","excerpt":"This method allows you to generate and send a PIN code over voice to provided destination address.","slug":"pin-send-over-voice","type":"endpoint","title":"PIN: Send over voice"}

postPIN: Send over voice

This method allows you to generate and send a PIN code over voice to provided destination address.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

to:
required
string
Phone number to which 2FA message will be delivered via voice. Must be in international format (Example: `41793026727`).
applicationId:
required
string
2FA application ID.
messageId:
required
string
ID of 2FA message that will be read to a phone number.
from:
string
Sender ID in *numeric* format. If this parameter is not set, it will be automatically filled from the created message parameter sender. If neither parameter value nor sender ID from the message is numeric, the default sender ID will be used.

Examples


Result Format


Documentation

## Response format On success, response header HTTP status code will be `200 OK`. On error, you will receive an [error response status code](doc:2fa-status-codes-and-error-details) in the header and the response body will contain an [error object](doc:2fa-status-codes-and-error-details). If you try to create an application when you do not have the user’s authorization, you will receive an error `401` Unauthorized. ### Response |Parameter|Type|Description| |-|-|-| |*to*|String|Phone number to which 2FA message was sent via voice.| |*callStatus*|String|Call status.| |*pinId*|String|Sent PIN code ID.| #### Call status list |Value|Description| |:---|:---| |`BAD_REQUEST`|Provided request does not meet required conditions.| |`PROCESSING`|Request is currently being processed.| |`PROCESSED`|Request is successfully processed and answered by human.| |`ANSWERED_MACHINE`|Request is successfully processed and answered by machine.| |`ERROR`|System error occurred during processing.| |`ERROR_NOT_ENOUGH_CREDITS`|Not enough credits on account balance to pay for the call.| |`ERROR_NETWORK_NOT_AVAILABLE`|We could not find network for given destination address.| |`ERROR_ROUTE_NOT_AVAILABLE`|Route for TTS call is not set up on account.| |`ERROR_USER_BUSY`|User was busy during call attempt(s).| |`ERROR_NO_ANSWER`|User did not answer call(s).| |`UNDEFINED`|Request is undefined.|