{"_id":"5613e4271db46e2100e142ad","user":"54eb4fdedf7add210007b29b","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":10,"slug":"2-factor-authentication","title":"2-factor authentication"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"54eb50e5615ffc1900305a16","version":{"_id":"54eb63b859b1172100334fae","project":"54eb50e5615ffc1900305a16","forked_from":"54eb63a1867e1917009b711d","__v":26,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"__v":1,"updates":["58a92272a790600f000e8844"],"next":{"pages":[],"description":""},"createdAt":"2015-10-06T15:09:27.031Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET /2fa/1/pin/9C817C6F8AF3D48F9FE553282AFA2B67/status HTTP/1.1\nHost: api.infobip.com\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\nContent-Type: application/json","name":""}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"status\": \"MESSAGE_DELIVERED\",\n    \"description\": \"Message sent and delivered\",\n    \"finalStatus\": true\n  },\n  {\n    \"status\": \"ERROR_USER_BUSY\",\n    \"description\": \"User was busy during call attempt(s).\"\n  }\n]","name":"OK"}]},"settings":"","auth":"required","params":[{"_id":"5613cdbeecbebc21003fa17b","ref":"","in":"path","required":true,"desc":"PIN code ID.","default":"","type":"string","name":"pinId"}],"url":"/2fa/:version/pin/:pinId/status"},"isReference":true,"order":14,"body":"# Response format\n\nOn success, response header HTTP status code will be `200 OK` and the body will contain sent SMS and call statuses.\n\nIf you try to get PIN statuses without authorization, you will receive an error `401 Unauthorized`.\n\n## Get PIN status response\n\n|Parameter|Type|Description|\n|-|-|-|\n|*status*|String|2FA message delivery status. <br>Status can have one of the following [values](#sms-status-list) if the PIN was sent via SMS, and one of the statuses from [call status list](#call-status-list) if the PIN was sent via voice.|\n|*description*|String|2FA message delivery status description.|\n|*finalStatus*|String|Indicates if 2FA message delivery status is final.|\n\n### SMS status list\n\n|Value|Description|FinalStatus|\n|:---|:---|:---|\n|``MESSAGE_ACCEPTED``|Message accepted| true|\n|``MESSAGE_NOT_SENT``|Message not sent| false|\n|``MESSAGE_NOT_DELIVERED``|Message sent, not delivered| true|\n|``MESSAGE_WAITING_DELIVERY``|Message sent, waiting for delivery|false|\n|``MESSAGE_DELIVERED``|Message sent and delivered|true|\n|``MESSAGE_NETWORK_NOT_ALLOWED``|Message not sent, network not allowed|true|\n|``MESSAGE_NETWORK_NOT_AVAILABLE``|Message not sent, bulk or gateway offline|true|\n|``MESSAGE_INVALID_DESTINATION_ADDRESS``|Message not sent, invalid destination address|true|\n|``MESSAGE_DELIVERY_UNKNOWN``|Message delivery unknown|true|\n|``INVALID_SOURCE_ADDRESS``|Message not sent, invalid source address|true|\n|``NOT_ENOUGH_CREDITS``|Message not sent, not enough credits|true|\n|``MESSAGE_REJECTED``|Message rejected|true|\n|``MESSAGE_EXPIRED``|Message expired|true|\n|``SYSTEM_ERROR``|System error|true|\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 get delivery information about all sent 2FA messages and all calls for one PIN code.","slug":"pin-get-status","type":"endpoint","title":"PIN: Get status"}

getPIN: Get status

This method allows you to get delivery information about all sent 2FA messages and all calls for one PIN code.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

pinId:
required
string
PIN code ID.

Examples


Result Format


Documentation

# Response format On success, response header HTTP status code will be `200 OK` and the body will contain sent SMS and call statuses. If you try to get PIN statuses without authorization, you will receive an error `401 Unauthorized`. ## Get PIN status response |Parameter|Type|Description| |-|-|-| |*status*|String|2FA message delivery status. <br>Status can have one of the following [values](#sms-status-list) if the PIN was sent via SMS, and one of the statuses from [call status list](#call-status-list) if the PIN was sent via voice.| |*description*|String|2FA message delivery status description.| |*finalStatus*|String|Indicates if 2FA message delivery status is final.| ### SMS status list |Value|Description|FinalStatus| |:---|:---|:---| |``MESSAGE_ACCEPTED``|Message accepted| true| |``MESSAGE_NOT_SENT``|Message not sent| false| |``MESSAGE_NOT_DELIVERED``|Message sent, not delivered| true| |``MESSAGE_WAITING_DELIVERY``|Message sent, waiting for delivery|false| |``MESSAGE_DELIVERED``|Message sent and delivered|true| |``MESSAGE_NETWORK_NOT_ALLOWED``|Message not sent, network not allowed|true| |``MESSAGE_NETWORK_NOT_AVAILABLE``|Message not sent, bulk or gateway offline|true| |``MESSAGE_INVALID_DESTINATION_ADDRESS``|Message not sent, invalid destination address|true| |``MESSAGE_DELIVERY_UNKNOWN``|Message delivery unknown|true| |``INVALID_SOURCE_ADDRESS``|Message not sent, invalid source address|true| |``NOT_ENOUGH_CREDITS``|Message not sent, not enough credits|true| |``MESSAGE_REJECTED``|Message rejected|true| |``MESSAGE_EXPIRED``|Message expired|true| |``SYSTEM_ERROR``|System error|true| ### 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.|

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}