# GoMessages API ## Docs - [Introduction](https://doc.gomessage.id/introduction-1886804m0.md): - [How to retrieve required IDs](https://doc.gomessage.id/how-to-retrieve-required-ids-1890345m0.md): - [How to retrieve API key](https://doc.gomessage.id/how-to-retrieve-api-key-1890751m0.md): - [Message](https://doc.gomessage.id/message-6012162f0.md): This is description of message ## API Docs - Channel > RCS [Create RCS Official account](https://doc.gomessage.id/create-rcs-official-account-25937401e0.md): This API is used to Create channel RCS by requesting a new RCS channel (Official account) by user requester. After requesting successfully, the RCS channel is created on the platform and in ***"Requested"*** status where the System Admin can Review and Accept the Creation. - Channel > RCS [Edit Channel RCS](https://doc.gomessage.id/edit-channel-rcs-25937402e0.md): This API is used to Edit RCS channel (Official account) information with Channel publicId. - Channel > RCS [Get Channel Rcs Status](https://doc.gomessage.id/get-channel-rcs-status-25937403e0.md): This API is used to Retrieve the RCS Official accounts status after requesting to launch by its publicId, mainly returns the current RCS Official account status. - Channel > RCS [Add Channel Test Number](https://doc.gomessage.id/add-channel-test-number-25937404e0.md): This API is used to Add test numbers to an RCS Channel by using the channel PublicId. - Channel > RCS [Check Bulk Phones](https://doc.gomessage.id/check-bulk-phones-25937405e0.md): This API is used to assess bulk phone numbers of users provided in the request whether a phone number is reachable or not on **RCS Channel**. This API works only with launched bots only. - Channel > RCS [Check capabilities of phone number](https://doc.gomessage.id/check-capabilities-of-phone-number-25937406e0.md): This API allows you to check which **RCS features** are supported by a specific user device. - Channel > RCS [Request Verification Channel](https://doc.gomessage.id/request-verification-channel-25937407e0.md): This API is used to submit or update RCS Channel (Official account) verification details for Launching Review. Updating is only allowed when the verification request status is ***NOT LAUNCH***. - Channel > ZALO [Check Zalo Channel Consent Status](https://doc.gomessage.id/check-zalo-channel-consent-status-25937408e0.md): This API is used Check Zalo's channel consent status whether the Zalo phone number accepts or rejects receiving messages and calls from Zalo Channel. - Channel > ZALO [Send Consent request](https://doc.gomessage.id/send-consent-request-25937409e0.md): This API is used to send consent request to a Zalo user. - Channel [Get channel information](https://doc.gomessage.id/get-channel-information-25937396e0.md): This API is used to Get channel information by Channel publicId - Channel [Get Channel Status](https://doc.gomessage.id/get-channel-status-25937397e0.md): This API is used to get channel status only. - Channel [Broadcast Template Message ](https://doc.gomessage.id/broadcast-template-message-25937398e0.md): This API is used to Send message to user on different Channels (RCS, Viber, Viber Bot, Whatsapp, Zalo and more ...) with a template publicId - Channel [Send Conversation Message](https://doc.gomessage.id/send-conversation-message-25937399e0.md): This API is used to Send conversation message to a user with injected content in the API call. - Channel [Broadcast Message](https://doc.gomessage.id/broadcast-message-25937400e0.md): This API is used to Send message to a user with a template by the template publicId. - Message [Get Message Status](https://doc.gomessage.id/get-message-status-25937410e0.md): This API is used to Get message status by message publicId or clientMessageId. Messages can be from different channels including RCS, Viber, Viber Bot, Whatsapp, Zalo and more ... - Template [Create Template](https://doc.gomessage.id/create-template-25937411e0.md): This API is used to Create a new template under a Channel by using the Channel publicId. - Template [Get Template By PublicId](https://doc.gomessage.id/get-template-by-publicid-25937412e0.md): This API is used to Get template details by Channel's publicId and Template publicId. - Template [Update Template](https://doc.gomessage.id/update-template-25937413e0.md): This API is used to Update template details by Channel's publicId and Template publicId. - Template [Get List Approved Template](https://doc.gomessage.id/get-list-approved-template-25937414e0.md): This API is used to Get a List of Approved Templates by using the Channel PublicId. - Template [Delete Template](https://doc.gomessage.id/delete-template-25937415e0.md): This API is used to Delete a template by the Channel's publicId and Template publicId. - Bulk Campaign [Get list bulk campaign](https://doc.gomessage.id/get-list-bulk-campaign-25937416e0.md): This API is used to retrieve bulk campaigns associated with the user’s API key for a specific company. - Bulk Campaign [Send Bulk Campaign Broadcast](https://doc.gomessage.id/send-bulk-campaign-broadcast-25937417e0.md): This API is used to Broadcast messages to phone number by a bulk campaign's publicId. This API can send message to different channels including RCS, Viber, Viber Bot, Whatsapp, Zalo - Bulk Campaign [Send Bulk Contact Message](https://doc.gomessage.id/send-bulk-contact-message-25937418e0.md): This API is used to Send message to a bulk campaign's contact with a defined message id (which is designed in the conversation template) - Billing CDR [Create billing request](https://doc.gomessage.id/create-billing-request-25937420e0.md): This API is used to Create a Background Task of Billing in a requested time and user can download file after the process done. - Billing CDR [Get billing request status](https://doc.gomessage.id/get-billing-request-status-25937421e0.md): This API is used to Get status of processing the billing in background task by Background Task publicId. - Billing CDR [Download billing](https://doc.gomessage.id/download-billing-25937422e0.md): This API is used to Download billing in Background Task after done processing. - Summary [Get Channel Summary](https://doc.gomessage.id/get-channel-summary-25937423e0.md): This API is used to Get Channel Summary on the amount of traffic of messages. ## Schemas - [ChannelTestRequest](https://doc.gomessage.id/channeltestrequest-11819033d0.md): - [ChannelTestResponse](https://doc.gomessage.id/channeltestresponse-11819034d0.md): - [CheckPhoneCapabilitiesResponse](https://doc.gomessage.id/checkphonecapabilitiesresponse-11819035d0.md): - [OnboardRequest](https://doc.gomessage.id/onboardrequest-11819036d0.md): - [OnboardResponse](https://doc.gomessage.id/onboardresponse-11819037d0.md): - [UpdateCompanyProfileRequest](https://doc.gomessage.id/updatecompanyprofilerequest-11819038d0.md): - [UpdateCompanyProfileResponse](https://doc.gomessage.id/updatecompanyprofileresponse-11819039d0.md): - [CreateAPIKeyRequest](https://doc.gomessage.id/createapikeyrequest-11819040d0.md): - [CreateAPIKeyResponse](https://doc.gomessage.id/createapikeyresponse-11819041d0.md): - [PartnerMessageType](https://doc.gomessage.id/partnermessagetype-11819042d0.md): - [MessageType](https://doc.gomessage.id/messagetype-11819043d0.md): - [Status](https://doc.gomessage.id/status-11819044d0.md): - [TemplateStatus](https://doc.gomessage.id/templatestatus-11819045d0.md): - [TemplateMessage](https://doc.gomessage.id/templatemessage-11819046d0.md): - [BroadcastSubscriberMessage](https://doc.gomessage.id/broadcastsubscribermessage-11819047d0.md): - [BroadcastSubscriberGroupMessage](https://doc.gomessage.id/broadcastsubscribergroupmessage-11819048d0.md): - [CreateOrEditChannelRequest](https://doc.gomessage.id/createoreditchannelrequest-11819049d0.md): - [LaunchChannelRequest](https://doc.gomessage.id/launchchannelrequest-11819050d0.md): - [LaunchChannelRequestIndonesia](https://doc.gomessage.id/launchchannelrequestindonesia-11819051d0.md): - [LaunchChannelRequestIndia](https://doc.gomessage.id/launchchannelrequestindia-11819052d0.md): - [CheckBulkPhonesRequest](https://doc.gomessage.id/checkbulkphonesrequest-11819053d0.md): - [SendMessageBroadcast](https://doc.gomessage.id/sendmessagebroadcast-11819054d0.md): - [TextMessage](https://doc.gomessage.id/textmessage-11819055d0.md): - [TextMessageWithAttachment](https://doc.gomessage.id/textmessagewithattachment-11819056d0.md): - [RichLink](https://doc.gomessage.id/richlink-11819057d0.md): - [ListPicker](https://doc.gomessage.id/listpicker-11819058d0.md): - [QuickReply](https://doc.gomessage.id/quickreply-11819059d0.md): - [FileMessage](https://doc.gomessage.id/filemessage-11819060d0.md): - [SuggestionActionType](https://doc.gomessage.id/suggestionactiontype-11819061d0.md): - [Suggestion](https://doc.gomessage.id/suggestion-11819062d0.md): - [RichCard](https://doc.gomessage.id/richcard-11819063d0.md): - [RCSRichCard](https://doc.gomessage.id/rcsrichcard-11819064d0.md): - [ViberRichCard](https://doc.gomessage.id/viberrichcard-11819065d0.md): - [ViberBotRichCard](https://doc.gomessage.id/viberbotrichcard-11819066d0.md): - [FBWhatsappInteractiveHeaderText](https://doc.gomessage.id/fbwhatsappinteractiveheadertext-11819067d0.md): - [FBWhatsappInteractiveHeaderMedia](https://doc.gomessage.id/fbwhatsappinteractiveheadermedia-11819068d0.md): - [FBWhatsappInteractive](https://doc.gomessage.id/fbwhatsappinteractive-11819069d0.md): - [FBWhatsappInteractiveButton](https://doc.gomessage.id/fbwhatsappinteractivebutton-11819070d0.md): - [FBWhatsappInteractiveList](https://doc.gomessage.id/fbwhatsappinteractivelist-11819071d0.md): - [WhatsappFormCreateTemplateMessage](https://doc.gomessage.id/whatsappformcreatetemplatemessage-11819072d0.md): - [CreateFormTemplateMessage](https://doc.gomessage.id/createformtemplatemessage-11819073d0.md): - [ResponseCreateTemplateMessage](https://doc.gomessage.id/responsecreatetemplatemessage-11819074d0.md): - [ResponseGetTemplate](https://doc.gomessage.id/responsegettemplate-11819075d0.md): - [ListSubscriberResponseMessage](https://doc.gomessage.id/listsubscriberresponsemessage-11819076d0.md): - [BroadcastResponseMessage](https://doc.gomessage.id/broadcastresponsemessage-11819077d0.md): - [ChannelResponse](https://doc.gomessage.id/channelresponse-11819078d0.md): - [ResponseMessage](https://doc.gomessage.id/responsemessage-11819079d0.md): - [ResponseStatusMessage](https://doc.gomessage.id/responsestatusmessage-11819080d0.md): - [ResponseSummaryChannelRCS](https://doc.gomessage.id/responsesummarychannelrcs-11819081d0.md): - [BulkCampaignBroadcastRequest](https://doc.gomessage.id/bulkcampaignbroadcastrequest-11819082d0.md): - [BulkCampaignBroadcastRequestMessage](https://doc.gomessage.id/bulkcampaignbroadcastrequestmessage-11819083d0.md): - [BulkCampaignSearchResponse](https://doc.gomessage.id/bulkcampaignsearchresponse-11819084d0.md): - [BulkCampaign](https://doc.gomessage.id/bulkcampaign-11819085d0.md): - [BulkCampaignStatus](https://doc.gomessage.id/bulkcampaignstatus-11819086d0.md): - [BulkCampaignType](https://doc.gomessage.id/bulkcampaigntype-11819087d0.md): - [BulkCampaignBroadcastResponse](https://doc.gomessage.id/bulkcampaignbroadcastresponse-11819088d0.md): - [BulkCampaignContact](https://doc.gomessage.id/bulkcampaigncontact-11819089d0.md): - [BulkCampaignConversationRequest](https://doc.gomessage.id/bulkcampaignconversationrequest-11819090d0.md): - [BulkCampaignConversationResponse](https://doc.gomessage.id/bulkcampaignconversationresponse-11819091d0.md): - [ChanelOnboardGenerateTokenRequest](https://doc.gomessage.id/chanelonboardgeneratetokenrequest-11819092d0.md): - [ChanelOnboardGenerateTokenResponse](https://doc.gomessage.id/chanelonboardgeneratetokenresponse-11819093d0.md): - [ErrorMessage](https://doc.gomessage.id/errormessage-11819094d0.md): - [Application](https://doc.gomessage.id/application-11819095d0.md): - [PartnerEvent](https://doc.gomessage.id/partnerevent-11819096d0.md): - [ResponseChannelInfo](https://doc.gomessage.id/responsechannelinfo-11819097d0.md): - [ResponseChannelRCSLaunchInfo](https://doc.gomessage.id/responsechannelrcslaunchinfo-11819098d0.md): - [CheckBulkPhonesResponse](https://doc.gomessage.id/checkbulkphonesresponse-11819099d0.md): - [ResponseListApproveTemplate](https://doc.gomessage.id/responselistapprovetemplate-11819100d0.md): - [RCSConversationParams](https://doc.gomessage.id/rcsconversationparams-11819101d0.md): - [ViberBotConversationParams](https://doc.gomessage.id/viberbotconversationparams-11819102d0.md): - [ViberConversationParams](https://doc.gomessage.id/viberconversationparams-11819103d0.md): - [AppleConversationParams](https://doc.gomessage.id/appleconversationparams-11819104d0.md): - [WhatsappConversationParams](https://doc.gomessage.id/whatsappconversationparams-11819105d0.md): - [CommonGetChannelStatusResponse](https://doc.gomessage.id/commongetchannelstatusresponse-11819106d0.md): - [WhatsappChannelStatusResponse](https://doc.gomessage.id/whatsappchannelstatusresponse-11819107d0.md): - [ChannelStatus](https://doc.gomessage.id/channelstatus-11819108d0.md): - [Attachment](https://doc.gomessage.id/attachment-11819109d0.md): - [AttachmentImage](https://doc.gomessage.id/attachmentimage-11819110d0.md): - [AttachmentLink](https://doc.gomessage.id/attachmentlink-11819111d0.md): - [AttachmentMiniProgram](https://doc.gomessage.id/attachmentminiprogram-11819112d0.md): - [AttachmentVideo](https://doc.gomessage.id/attachmentvideo-11819113d0.md): - [AttachmentFile](https://doc.gomessage.id/attachmentfile-11819114d0.md): - [backgroundTask](https://doc.gomessage.id/backgroundtask-11819115d0.md): - [ZaloRequestConsentRequest](https://doc.gomessage.id/zalorequestconsentrequest-11819116d0.md): - [ZaloCheckConsentResponse](https://doc.gomessage.id/zalocheckconsentresponse-11819117d0.md): - [ZaloRequestConsentResponse](https://doc.gomessage.id/zalorequestconsentresponse-11819118d0.md):