INinfobip
customer-engagement
conversations
conversation-messages

Create message

Inbound messages are automatically threaded in conversations if the channels and senders are configured for using Conversations. To send an outbound message use this method with the following parameters, adding it to an existing conversation. Please note that the response from sending a TEMPLATE content type is a message of the TEXT content type, containing the template content filled with parameters.

Also, HTTP header should contain parameter "x-agent-id" as agent identifier, but only in case conversations are assigned to agents. <a href="https://www.infobip.com/docs/conversations-api/messages" target="_blank">More info</a>

post/ccaas/1/conversations/{conversationId}/messages

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

conversationIdstring required

Id of the conversation to set message for.

Request body

channel'SMS' | 'VIBER' | 'FACEBOOK_MESSENGER' | 'WHATSAPP' | 'RCS' | 'LIVE_CHAT' | 'LINE' | 'APPLE_BUSINESS_CHAT' | 'EMAIL' | 'TELEGRAM' | 'INSTAGRAM_MESSAGING' | 'KAKAO_SANGDAM' | 'VIBER_BOT' required

Available communication channels

fromstring required

Sender phone number, email address, FB messenger Id or live chat widget Id.

tostring required

Destination phone number, email address, FB messenger or live chat user Id.

contentE89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2MessageContent required

Message content depending on content type.

contentType'TEXT' | 'IMAGE' | 'LOCATION' | 'TEMPLATE' | 'AUDIO' | 'UNKNOWN' | 'VOICE' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'VOICE_CALL' | 'VIDEO_CALL' | 'BUTTON' | 'TYPING_INDICATOR' | 'LIST_PICKER' | 'FILE' | 'LIST_PICKER_RESPONSE' | 'POSTBACK' | 'WA_BUTTON_FEEDBACK' | 'SURVEY_REQUEST' | 'SURVEY_RESPONSE' | 'MEDIA_TEMPLATE' | 'FACEBOOK_TEMPLATE' | 'PRE_CHAT_FORM' | 'LC_QUICK_REPLY' | 'TEXT_WITH_BUTTON' | 'TEXT_WITH_IMAGE_AND_BUTTON' | 'SUGGESTION_RESPONSE' | 'ABC_MULTI_TYPE' | 'FOLLOW' | 'UNFOLLOW' | 'CALL' | 'EMAIL' | 'CARD' | 'CAROUSEL' | 'TEXT_WITH_SUGGESTION' | 'RICH_LINK' | 'TIME_PICKER' | 'TIME_PICKER_RESPONSE' | 'BUTTON_RESPONSE' | 'VIBER_BOT_STICKER' | 'WHATSAPP_STICKER' | 'VIBER_BOT_CAROUSEL' | 'VIBER_BOT_EVENT' | 'VIBER_BOT_VIDEO' | 'VIBER_BOT_FILE' | 'URL' | 'LC_CAROUSEL' | 'INSTAGRAM_STICKER' | 'CALL_START' | 'CALL_HANGUP' | 'CALL_TRANSCRIPT' | 'CALL_FILE' | 'APPLE_CUSTOM_INTERACTIVE_CONTENT' | 'APPLE_AUTH_REQUEST_CONTENT' | 'APPLE_PAY_REQUEST_CONTENT' | 'APPLE_PAY_RESPONSE' | 'AUTHENTICATION_RESPONSE' | 'CLOSE_CONVERSATION' | 'BUTTON_LIST' | 'KAKAO_SANGDAM_SESSION_EXPIRED' | 'INSTAGRAM_TEMPLATE' | 'SHARE' | 'STORY_MENTION' | 'CUSTOM_INTERACTIVE_RESPONSE' | 'INTERACTIVE' | 'INTERACTIVE_LIST_REPLY' | 'INTERACTIVE_BUTTON_REPLY' | 'LC_FORM_RESPONSE' | 'PRODUCT' | 'APPLE_QUICK_REPLY_CONTENT' | 'QUICK_REPLY' | 'WHATSAPP_PRODUCT' | 'WHATSAPP_MULTI_PRODUCT' | 'WHATSAPP_TEXT_WITH_ADDITIONAL_DATA' | 'ORDER' | 'TELEGRAM_CONTACT' | 'FORM_RESPONSE' | 'LINE_TEMPLATE' | 'APPLE_FORM_CONTENT' | 'LINE_POSTBACK_EVENT' | 'LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE' | 'LIVE_CHAT_KNOWLEDGE_BASE_SEARCH' | 'LINE_STICKER' | 'INTERACTIVE_FLOW_REPLY' | 'RCS_TEXT' | 'RCS_FILE' | 'RCS_CARD' | 'RCS_CAROUSEL' | 'BUNDLE' | 'PRIVATE_REPLY_TO_SOCIAL_COMMENT' | 'LIVE_CHAT_BUTTON' | 'TEXT_WITH_RATING' | 'EMPTY' | 'JSON' | 'ROADSIDE_ASSISTANCE' | 'CUSTOM_DATA' | 'WHATSAPP_CALL_PERMISSION_REPLY' | 'TIKTOK_SHARE_POST' | 'TIKTOK_REFERRAL_SHORT_LINK' | 'TIKTOK_REFERRAL_AD' | 'ZALO_GIF' | 'RCS_TEXT_WITH_PDF' | 'APPLE_MEDIA_CONTENT' | 'TEXT' | 'IMAGE' | 'LOCATION' | 'TEMPLATE' | 'AUDIO' | 'VOICE' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'VOICE_CALL' | 'VIDEO_CALL' | 'CALL' | 'BUTTON' | 'TYPING_INDICATOR' | 'LIST_PICKER' | 'FILE' | 'LIST_PICKER_RESPONSE' | 'POSTBACK' | 'SURVEY_REQUEST' | 'SURVEY_RESPONSE' | 'FACEBOOK_TEMPLATE' | 'PRE_CHAT_FORM' | 'LC_FORM_RESPONSE' | 'LC_QUICK_REPLY' | 'LC_CAROUSEL' | 'LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE' | 'LIVE_CHAT_KNOWLEDGE_BASE_SEARCH' | 'TEXT_WITH_BUTTON' | 'TEXT_WITH_IMAGE_AND_BUTTON' | 'ABC_MULTI_TYPE' | 'CARD' | 'SUGGESTION_RESPONSE' | 'CAROUSEL' | 'LINE_TEMPLATE' | 'TEXT_WITH_SUGGESTION' | 'EMAIL' | 'RICH_LINK' | 'TIME_PICKER' | 'TIME_PICKER_RESPONSE' | 'BUTTON_RESPONSE' | 'WHATSAPP_STICKER' | 'VIBER_STICKER' | 'INSTAGRAM_STICKER' | 'INSTAGRAM_TEMPLATE' | 'CALL_FILE' | 'CALL_TRANSCRIPT' | 'CALL_HANGUP' | 'CALL_START' | 'ABC_CUSTOM_INTERACTIVE_CONTENT' | 'APPLE_PAY_REQUEST_CONTENT' | 'QUICK_REPLY' | 'APPLE_AUTH_REQUEST_CONTENT' | 'APPLE_CUSTOM_INTERACTIVE_CONTENT' | 'BUTTON_LIST' | 'SHARE' | 'INTERACTIVE' | 'KAKAO_SANGDAM_SESSION_EXPIRED' | 'INTERACTIVE_BUTTON_REPLY' | 'INTERACTIVE_LIST_REPLY' | 'WHATSAPP_PRODUCT' | 'WHATSAPP_MULTI_PRODUCT' | 'PRODUCT' | 'APPLE_QUICK_REPLY_CONTENT' | 'APPLE_FORM_CONTENT' | 'ROADSIDE_ASSISTANCE' | 'FORM_RESPONSE' | 'ORDER' | 'LINE_POSTBACK_EVENT' | 'INTERACTIVE_FLOW_REPLY' | 'RCS_TEXT' | 'RCS_FILE' | 'RCS_CARD' | 'RCS_CAROUSEL' | 'PRIVATE_REPLY_TO_SOCIAL_COMMENT' | 'CUSTOM_DATA' | 'WHATSAPP_CALL_PERMISSION_REPLY' required

Content type

replyToMessageIdstring

Quoted message ID - available for WhatsApp messages

Response

OK

idstring

Message Id

channel'SMS' | 'VIBER' | 'FACEBOOK_MESSENGER' | 'WHATSAPP' | 'RCS' | 'UNKNOWN' | 'EMAIL' | 'LIVE_CHAT' | 'UNUSED' | 'VOICE' | 'VIDEO' | 'APPLE_BUSINESS_CHAT' | 'LINE' | 'GOOGLE_BUSINESS_MESSAGES' | 'TELEGRAM' | 'CALLS' | 'INTERNAL' | 'VIBER_BOT' | 'FACEBOOK_POST' | 'INSTAGRAM_POST' | 'TWITTER_POST' | 'INSTAGRAM_MESSAGING' | 'GOOGLE_PLAY' | 'KAKAO_SANGDAM' | 'TWITTER_DM' | 'WHATSAPP_CALLS' | 'VIBER_CALLS' | 'OPEN_CHANNEL' | 'TIKTOK' | 'ZALO' | 'SMS' | 'VIBER' | 'FACEBOOK_MESSENGER' | 'WHATSAPP' | 'RCS' | 'LIVE_CHAT' | 'LINE' | 'APPLE_BUSINESS_CHAT' | 'TELEGRAM' | 'INSTAGRAM_MESSAGING' | 'KAKAO_SANGDAM' | 'VIBER_BOT' | 'EMAIL'

Available communication channels

fromstring

Sender phone number, email address, FB messenger Id or live chat widget Id.

tostring

Destination phone number, email address, FB messenger or live chat user Id.

direction'INBOUND' | 'OUTBOUND' | 'INBOUND' | 'OUTBOUND'

Message direction

conversationIdstring

Id of the conversation message belongs to.

authorIdstring

Internal unique ID of the customer or agent, determined by the author type.

authorType'CUSTOMER' | 'AGENT' | 'SYSTEM' | 'BOT'

Indicates if the message was written by the agent, bot, or the system.

createdAtstring date-time

Time stamp when message is created.

updatedAtstring date-time

Time stamp when message is updated.

contentE89661b226e518f36a162935afcdf1132c95b0e63e9c86c5ef5f31c5a8d865a2MessageContent

Message content depending on content type.

contentType'TEXT' | 'IMAGE' | 'LOCATION' | 'TEMPLATE' | 'AUDIO' | 'UNKNOWN' | 'VOICE' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'VOICE_CALL' | 'VIDEO_CALL' | 'BUTTON' | 'TYPING_INDICATOR' | 'LIST_PICKER' | 'FILE' | 'LIST_PICKER_RESPONSE' | 'POSTBACK' | 'WA_BUTTON_FEEDBACK' | 'SURVEY_REQUEST' | 'SURVEY_RESPONSE' | 'MEDIA_TEMPLATE' | 'FACEBOOK_TEMPLATE' | 'PRE_CHAT_FORM' | 'LC_QUICK_REPLY' | 'TEXT_WITH_BUTTON' | 'TEXT_WITH_IMAGE_AND_BUTTON' | 'SUGGESTION_RESPONSE' | 'ABC_MULTI_TYPE' | 'FOLLOW' | 'UNFOLLOW' | 'CALL' | 'EMAIL' | 'CARD' | 'CAROUSEL' | 'TEXT_WITH_SUGGESTION' | 'RICH_LINK' | 'TIME_PICKER' | 'TIME_PICKER_RESPONSE' | 'BUTTON_RESPONSE' | 'VIBER_BOT_STICKER' | 'WHATSAPP_STICKER' | 'VIBER_BOT_CAROUSEL' | 'VIBER_BOT_EVENT' | 'VIBER_BOT_VIDEO' | 'VIBER_BOT_FILE' | 'URL' | 'LC_CAROUSEL' | 'INSTAGRAM_STICKER' | 'CALL_START' | 'CALL_HANGUP' | 'CALL_TRANSCRIPT' | 'CALL_FILE' | 'APPLE_CUSTOM_INTERACTIVE_CONTENT' | 'APPLE_AUTH_REQUEST_CONTENT' | 'APPLE_PAY_REQUEST_CONTENT' | 'APPLE_PAY_RESPONSE' | 'AUTHENTICATION_RESPONSE' | 'CLOSE_CONVERSATION' | 'BUTTON_LIST' | 'KAKAO_SANGDAM_SESSION_EXPIRED' | 'INSTAGRAM_TEMPLATE' | 'SHARE' | 'STORY_MENTION' | 'CUSTOM_INTERACTIVE_RESPONSE' | 'INTERACTIVE' | 'INTERACTIVE_LIST_REPLY' | 'INTERACTIVE_BUTTON_REPLY' | 'LC_FORM_RESPONSE' | 'PRODUCT' | 'APPLE_QUICK_REPLY_CONTENT' | 'QUICK_REPLY' | 'WHATSAPP_PRODUCT' | 'WHATSAPP_MULTI_PRODUCT' | 'WHATSAPP_TEXT_WITH_ADDITIONAL_DATA' | 'ORDER' | 'TELEGRAM_CONTACT' | 'FORM_RESPONSE' | 'LINE_TEMPLATE' | 'APPLE_FORM_CONTENT' | 'LINE_POSTBACK_EVENT' | 'LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE' | 'LIVE_CHAT_KNOWLEDGE_BASE_SEARCH' | 'LINE_STICKER' | 'INTERACTIVE_FLOW_REPLY' | 'RCS_TEXT' | 'RCS_FILE' | 'RCS_CARD' | 'RCS_CAROUSEL' | 'BUNDLE' | 'PRIVATE_REPLY_TO_SOCIAL_COMMENT' | 'LIVE_CHAT_BUTTON' | 'TEXT_WITH_RATING' | 'EMPTY' | 'JSON' | 'ROADSIDE_ASSISTANCE' | 'CUSTOM_DATA' | 'WHATSAPP_CALL_PERMISSION_REPLY' | 'TIKTOK_SHARE_POST' | 'TIKTOK_REFERRAL_SHORT_LINK' | 'TIKTOK_REFERRAL_AD' | 'ZALO_GIF' | 'RCS_TEXT_WITH_PDF' | 'APPLE_MEDIA_CONTENT' | 'TEXT' | 'IMAGE' | 'LOCATION' | 'TEMPLATE' | 'AUDIO' | 'VOICE' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'VOICE_CALL' | 'VIDEO_CALL' | 'CALL' | 'BUTTON' | 'TYPING_INDICATOR' | 'LIST_PICKER' | 'FILE' | 'LIST_PICKER_RESPONSE' | 'POSTBACK' | 'SURVEY_REQUEST' | 'SURVEY_RESPONSE' | 'FACEBOOK_TEMPLATE' | 'PRE_CHAT_FORM' | 'LC_FORM_RESPONSE' | 'LC_QUICK_REPLY' | 'LC_CAROUSEL' | 'LIVE_CHAT_KNOWLEDGE_BASE_ARTICLE' | 'LIVE_CHAT_KNOWLEDGE_BASE_SEARCH' | 'TEXT_WITH_BUTTON' | 'TEXT_WITH_IMAGE_AND_BUTTON' | 'ABC_MULTI_TYPE' | 'CARD' | 'SUGGESTION_RESPONSE' | 'CAROUSEL' | 'LINE_TEMPLATE' | 'TEXT_WITH_SUGGESTION' | 'EMAIL' | 'RICH_LINK' | 'TIME_PICKER' | 'TIME_PICKER_RESPONSE' | 'BUTTON_RESPONSE' | 'WHATSAPP_STICKER' | 'VIBER_STICKER' | 'INSTAGRAM_STICKER' | 'INSTAGRAM_TEMPLATE' | 'CALL_FILE' | 'CALL_TRANSCRIPT' | 'CALL_HANGUP' | 'CALL_START' | 'ABC_CUSTOM_INTERACTIVE_CONTENT' | 'APPLE_PAY_REQUEST_CONTENT' | 'QUICK_REPLY' | 'APPLE_AUTH_REQUEST_CONTENT' | 'APPLE_CUSTOM_INTERACTIVE_CONTENT' | 'BUTTON_LIST' | 'SHARE' | 'INTERACTIVE' | 'KAKAO_SANGDAM_SESSION_EXPIRED' | 'INTERACTIVE_BUTTON_REPLY' | 'INTERACTIVE_LIST_REPLY' | 'WHATSAPP_PRODUCT' | 'WHATSAPP_MULTI_PRODUCT' | 'PRODUCT' | 'APPLE_QUICK_REPLY_CONTENT' | 'APPLE_FORM_CONTENT' | 'ROADSIDE_ASSISTANCE' | 'FORM_RESPONSE' | 'ORDER' | 'LINE_POSTBACK_EVENT' | 'INTERACTIVE_FLOW_REPLY' | 'RCS_TEXT' | 'RCS_FILE' | 'RCS_CARD' | 'RCS_CAROUSEL' | 'PRIVATE_REPLY_TO_SOCIAL_COMMENT' | 'CUSTOM_DATA' | 'WHATSAPP_CALL_PERMISSION_REPLY'

Content type

Changes

No recorded changes to this operation across all 1 revision of this API.