{"_id":"56249f0c85a31117001c53e1","user":"54eb4fdedf7add210007b29b","parentDoc":null,"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"},"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,"project":"54eb50e5615ffc1900305a16","__v":2,"editedParams2":true,"updates":["58a92072a790600f000e8843"],"next":{"pages":[],"description":""},"createdAt":"2015-10-19T07:43:08.521Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"[\n {\n  \"messageId\": \"9C815F8AF3328\",\n  \"applicationId\": \"HJ675435E3A6EA43432G5F37A635KJ8B\",\n  \"pinPlaceholder\": \"<pin>\",\n  \"messageText\": \"Your PIN is <pin>.\",\n  \"pinLength\": 4,\n  \"pinType\": \"NUMERIC\",\n  \"language\": \"en\",\n  \"repeatDTMF\": \"1#\",\n  \"speechRate\": 1\n },\n {\n  \"messageId\": \"8F0792F86035A\",\n  \"applicationId\": \"HJ675435E3A6EA43432G5F37A635KJ8B\",\n  \"pinPlaceholder\": \"<<>>\",\n  \"messageText\": \"Your PIN is <<>>.\",\n  \"pinLength\": 6,\n  \"pinType\": \"HEXA\",\n  \"repeatDTMF\": \"1#\",\n  \"speechRate\": 1.5\n }\n]","language":"json","status":200},{"name":"","code":"{\n  \"requestError\": {\n    \"serviceException\": {\n      \"messageId\": \"MESSAGE_NOT_FOUND\",\n      \"text\": \"Message with given id cannot be found.\"\n    }\n  }\n}","language":"json","status":404},{"code":"{\n  \"requestError\": {\n    \"serviceException\": {\n      \"messageId\": \"THROTTLE_EXCEPTION\",\n      \"text\": \"Too many requests. Try again later.\"\n    }\n  }\n}","language":"json","status":429}]},"settings":"","examples":{"codes":[{"name":"","code":"GET /2fa/1/applications/HJ675435E3A6EA43432G5F37A635KJ8B/messages HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nContent-Type: application/json","language":"json"}]},"auth":"required","params":[{"_id":"56249c2bce14050d008085e6","ref":"","in":"path","required":false,"desc":"2FA application ID for which the requested message was created.","default":"","type":"string","name":"applicationId"},{"_id":"56249df185a31117001c53df","ref":"","in":"path","required":false,"desc":"Requested message ID.","default":"","type":"string","name":"messageId"}],"url":"/2fa/:version/applications/:applicationId/messages/:messageId"},"isReference":true,"order":6,"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|*messageId*|String|2FA message ID.|\n|*applicationId*|String|2FA application ID for which the message was created.|\n|*pinPlaceholder*|String|PIN code placeholder. Right before sending SMS, PIN code placeholder will be replaced with generated PIN code.|\n|*messageText*|String|Text of a message that will be sent. |\n|*pinLength*|Integer|PIN code length.|\n|*pinType*|String|Type of PIN code that will be generated and sent as part of 2FA message.|\n|*repeatDTMF*|String|DTMF code which enables repeating message if subscriber enters it.|\n|*speechRate*|Double|The speed of speech for the resulting message. Supported range is from 0.5 to 2.|\n|*senderId*|String| The name that will appear as the sender of the 2FA message (Example: CompanyName).|\n|*language*|String|Language code of language in which message text is written. It is used for reading the message when it is sent via voice. If no language is set, message will be read in English. Supported languages are listed in the table below.|\n\n#### Suported languages\n\n|Language code|Language|\n|-|-|\n|*en*|English|\n|*es*|Spanish|\n|*ca*|Catalan|\n|*zh-cn*|Chinese - simplified|\n|*zh-tw*|Chinese - traditional|\n|*da*|Danish|\n|*nl*|Dutch|\n|*fr*|French|\n|*de*|German|\n|*it*|Italian|\n|*ja*|Japanese|\n|*ko*|Korean|\n|*no*|Norwegian|\n|*pl*|Polish|\n|*pt-pt*|Portuguese|\n|*ru*|Russian|\n|*sv*|Swedish|\n|*fi*|Finnish|\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Additional example\"\n}\n[/block]\n# Get one message by `applicationId` and `messageId`\n\n**Request**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /2fa/1/applications/HJ675435E3A6EA43432G5F37A635KJ8B/messages/F66D67327326FCC HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\\nContent-Type: application/json\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"messageId\\\": \\\"F66D67327326FCC\\\",\\n \\\"applicationId\\\": \\\"HJ675435E3A6EA43432G5F37A635KJ8B\\\",\\n \\\"pinPlaceholder\\\": \\\"<pin>\\\",\\n \\\"messageText\\\": \\\"Your pin is <pin>\\\",\\n \\\"pinLength\\\": 6,\\n \\\"pinType\\\": \\\"ALPHANUMERIC\\\",\\n \\\"senderId\\\": \\\"Infobip 2FA\\\",\\n \\\"language\\\": \\\"en\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"This method allows you to get all 2FA messages for specific application. Also, you can get just one 2FA message identified by `messageId`.","slug":"message-get","type":"endpoint","title":"Message: Get"}

getMessage: Get

This method allows you to get all 2FA messages for specific application. Also, you can get just one 2FA message identified by `messageId`.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

applicationId:
string
2FA application ID for which the requested message was created.
messageId:
string
Requested message ID.

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| |-|-|-| |*messageId*|String|2FA message ID.| |*applicationId*|String|2FA application ID for which the message was created.| |*pinPlaceholder*|String|PIN code placeholder. Right before sending SMS, PIN code placeholder will be replaced with generated PIN code.| |*messageText*|String|Text of a message that will be sent. | |*pinLength*|Integer|PIN code length.| |*pinType*|String|Type of PIN code that will be generated and sent as part of 2FA message.| |*repeatDTMF*|String|DTMF code which enables repeating message if subscriber enters it.| |*speechRate*|Double|The speed of speech for the resulting message. Supported range is from 0.5 to 2.| |*senderId*|String| The name that will appear as the sender of the 2FA message (Example: CompanyName).| |*language*|String|Language code of language in which message text is written. It is used for reading the message when it is sent via voice. If no language is set, message will be read in English. Supported languages are listed in the table below.| #### Suported languages |Language code|Language| |-|-| |*en*|English| |*es*|Spanish| |*ca*|Catalan| |*zh-cn*|Chinese - simplified| |*zh-tw*|Chinese - traditional| |*da*|Danish| |*nl*|Dutch| |*fr*|French| |*de*|German| |*it*|Italian| |*ja*|Japanese| |*ko*|Korean| |*no*|Norwegian| |*pl*|Polish| |*pt-pt*|Portuguese| |*ru*|Russian| |*sv*|Swedish| |*fi*|Finnish| [block:api-header] { "type": "basic", "title": "Additional example" } [/block] # Get one message by `applicationId` and `messageId` **Request** [block:code] { "codes": [ { "code": "GET /2fa/1/applications/HJ675435E3A6EA43432G5F37A635KJ8B/messages/F66D67327326FCC HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nContent-Type: application/json", "language": "json" } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"messageId\": \"F66D67327326FCC\",\n \"applicationId\": \"HJ675435E3A6EA43432G5F37A635KJ8B\",\n \"pinPlaceholder\": \"<pin>\",\n \"messageText\": \"Your pin is <pin>\",\n \"pinLength\": 6,\n \"pinType\": \"ALPHANUMERIC\",\n \"senderId\": \"Infobip 2FA\",\n \"language\": \"en\"\n}", "language": "json" } ] } [/block]

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 }}