{"_id":"597b35e59515ef0030e51f5b","project":"54eb50e5615ffc1900305a16","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"},"category":{"_id":"5954bc387a147f001b918915","project":"54eb50e5615ffc1900305a16","version":"54eb63b859b1172100334fae","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-06-29T08:37:12.853Z","from_sync":false,"order":7,"slug":"omni-chat","title":"OMNI Chat"},"user":"57a98d832242630e00cc8df7","__v":8,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-28T13:02:29.016Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"554860d6d2c8410d006c215e","examples":{"codes":[{"name":"","code":"POST /omnichat/:version/applications/0F3C3F29829FAB88714BA205BEC6D28F/integrations/FACEBOOK/invite HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nContent-Type: application/json\nAccept: application/json\n\n{\n  \"to\":\"41793026727\",\n  \"linkPlaceholder\":\"<link>\",\n  \"message\":\"Hello, if you'd like to hear more about Foo, follow us at <link>\"\n}","language":"json"}]},"method":"post","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"to\": \"41793026727\",\n  \"messageCount\": 1,\n  \"messageId\": \"1215f543ab19-345f-adbd-12ad31451ed25f35\",\n  \"status\": {\n    \"groupId\": 1,\n    \"groupName\": \"PENDING\",\n    \"id\": 7,\n    \"name\": \"PENDING_ENROUTE\",\n    \"description\": \"Message sent to next instance\"\n  }\n}"},{"status":400,"language":"json","code":"{\n  \"requestError\": {\n    \"serviceException\": {\n      \"messageId\": \"BAD_REQUEST\",\n      \"text\": \"Bad request\"\n    }\n  }\n}","name":""},{"language":"json","status":401,"code":"{\n  \"requestError\": {\n    \"serviceException\": {\n      \"messageId\": \"UNAUTHORIZED\",\n      \"text\": \"Invalid login details\"\n    }\n  }\n}"}]},"auth":"required","params":[{"_id":"55155f2abc466623002afe8a","ref":"","in":"body","required":true,"desc":"Phone number to which invite will be sent. Must be in international format (Example: `41793026727`).","default":"","type":"string","name":"to"},{"_id":"55155f2abc466623002afe89","ref":"","in":"body","required":true,"desc":"Link placeholder. This value should be part of a message text and it will be replaced with generated invite link.","default":"","type":"string","name":"linkPlaceholder"},{"_id":"59550843be8877001b6dcfee","ref":"","in":"path","required":true,"desc":"","default":"application key","type":"string","name":"applicationKey"},{"_id":"59550843be8877001b6dcfed","ref":"","in":"path","required":true,"desc":"","default":"integration type","type":"string","name":"integrationType"},{"_id":"597b3758a5636800424bbf22","ref":"","in":"body","required":true,"desc":"Text of a message that will be sent. Message should contain link placeholder.","default":"","type":"string","name":"message"},{"_id":"5a0edf72b1dc65003e8e720e","ref":"","in":"body","required":false,"desc":"Represents sender ID and it can be alphanumeric or numeric. *Alphanumeric* sender ID length should be between 3 and 11 characters (Example: `CompanyName`). *Numeric* sender ID length should be between 3 and 14 characters.","default":"","type":"string","name":"from"}],"url":"/omnichat/:version/applications/{applicationKey}/integrations/{integrationType}/invite"},"isReference":false,"order":9,"body":"# Response format \nIf successful, the response header HTTP status code will be 200 OK and the message will be sent.\nIf you try to send the message without authorization, you will receive a 401 Unauthorized error.\nIn case of an incorrectly formatted request, the HTTP status code will be `400 Bad Request`.\n\n\n####Response\n\n|Parameter|Type|Description|\n|-|-|-|\n|*to*|String|Phone number to which link was sent.|\n|*status*|[Status](#section-status)|Indicates whether the message is sent successfully, not sent, delivered, not delivered, waiting for delivery or any other possible status.|\n|*messageCount*|int|The number of sent message segments.|\n|*messageId*|String|The ID that uniquely identifies the sent message.|\n\n####Status\n\n|Parameter|Type|Description|\n|-|-|-|\n|*groupId*|int|Status [group ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*groupName*|String|Status [group name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*id*|int|Status [ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*name*|String|Status [name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*description*|String|Human readable [description](http://dev.infobip.com/v1/docs/response-codes#status-object-example) of the status.|\n|*action*|String|[Action](http://dev.infobip.com/v1/docs/response-codes#status-object-example) that should be taken to eliminate the error.|","excerpt":"This method allows you to send a single SMS invite.","slug":"omni-chat-integration-send-sms-invite","type":"endpoint","title":"Send Integration SMS invite"}

postSend Integration SMS invite

This method allows you to send a single SMS invite.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

applicationKey:
required
stringapplication key
integrationType:
required
stringintegration type

Body Params

to:
required
string
Phone number to which invite will be sent. Must be in international format (Example: `41793026727`).
linkPlaceholder:
required
string
Link placeholder. This value should be part of a message text and it will be replaced with generated invite link.
message:
required
string
Text of a message that will be sent. Message should contain link placeholder.
from:
string
Represents sender ID and it can be alphanumeric or numeric. *Alphanumeric* sender ID length should be between 3 and 11 characters (Example: `CompanyName`). *Numeric* sender ID length should be between 3 and 14 characters.

Examples


Result Format


Documentation

# Response format If successful, the response header HTTP status code will be 200 OK and the message will be sent. If you try to send the message without authorization, you will receive a 401 Unauthorized error. In case of an incorrectly formatted request, the HTTP status code will be `400 Bad Request`. ####Response |Parameter|Type|Description| |-|-|-| |*to*|String|Phone number to which link was sent.| |*status*|[Status](#section-status)|Indicates whether the message is sent successfully, not sent, delivered, not delivered, waiting for delivery or any other possible status.| |*messageCount*|int|The number of sent message segments.| |*messageId*|String|The ID that uniquely identifies the sent message.| ####Status |Parameter|Type|Description| |-|-|-| |*groupId*|int|Status [group ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*groupName*|String|Status [group name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*id*|int|Status [ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*name*|String|Status [name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*description*|String|Human readable [description](http://dev.infobip.com/v1/docs/response-codes#status-object-example) of the status.| |*action*|String|[Action](http://dev.infobip.com/v1/docs/response-codes#status-object-example) that should be taken to eliminate the error.|