# MMP Message API ## Docs - [Introduction](https://doc.peacom.co/introduction-1892835m0.md): - [How to retrieve required IDs](https://doc.peacom.co/how-to-retrieve-required-ids-1892836m0.md): - [How to retrieve API key](https://doc.peacom.co/how-to-retrieve-api-key-1892839m0.md): - [Onboard](https://doc.peacom.co/onboard.md): - [Message](https://doc.peacom.co/message-5890441f0.md): This is description of message ## API Docs - Onboard [Onboard new Company and Company's Admin](https://doc.peacom.co/onboard-new-company-and-companys-admin-25454442e0.md): This API is used to Create new user and company on the platform by System Admin apiKey. The new user account created with the new company is the Company Admin by default. - Onboard [Update company profile](https://doc.peacom.co/update-company-profile-25454443e0.md): This API is used to Update a company profile by company's public ID, using System Admin apiKey. - Onboard [Create a new API key](https://doc.peacom.co/create-a-new-api-key-25454444e0.md): This API is used to Create new API key under a particular company, using System Admin apiKey. - Channel > RCS [Create RCS Official account](https://doc.peacom.co/create-rcs-official-account-25454447e0.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.peacom.co/edit-channel-rcs-25454449e0.md): This API is used to Edit RCS channel (Official account) information with Channel publicId. - Channel > RCS [Get Channel Rcs Status](https://doc.peacom.co/get-channel-rcs-status-25454451e0.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.peacom.co/add-channel-test-number-25454465e0.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.peacom.co/check-bulk-phones-25454452e0.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.peacom.co/check-capabilities-of-phone-number-25454466e0.md): This API allows you to check which **RCS features** are supported by a specific user device. - Channel > RCS [Request Verification Channel](https://doc.peacom.co/request-verification-channel-25454450e0.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.peacom.co/check-zalo-channel-consent-status-25454469e0.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.peacom.co/send-consent-request-25454470e0.md): This API is used to send consent request to a Zalo user. - Channel [Get channel information](https://doc.peacom.co/get-channel-information-25454448e0.md): This API is used to Get channel information by Channel publicId - Channel [Get Channel Status](https://doc.peacom.co/get-channel-status-25454468e0.md): This API is used to get channel status only. - Channel [Broadcast Template Message ](https://doc.peacom.co/broadcast-template-message-25454460e0.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.peacom.co/send-conversation-message-25454467e0.md): This API is used to Send conversation message to a user with injected content in the API call. - Channel [Broadcast Message](https://doc.peacom.co/broadcast-message-25454454e0.md): This API is used to Send message to a user with a template by the template publicId. - Message [Get Message Status](https://doc.peacom.co/get-message-status-25454445e0.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.peacom.co/create-template-25454456e0.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.peacom.co/get-template-by-publicid-25454457e0.md): This API is used to Get template details by Channel's publicId and Template publicId. - Template [Update Template](https://doc.peacom.co/update-template-25454458e0.md): This API is used to Update template details by Channel's publicId and Template publicId. - Template [Get List Approved Template](https://doc.peacom.co/get-list-approved-template-25454455e0.md): This API is used to Get a List of Approved Templates by using the Channel PublicId. - Template [Delete Template](https://doc.peacom.co/delete-template-25454459e0.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.peacom.co/get-list-bulk-campaign-25454471e0.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.peacom.co/send-bulk-campaign-broadcast-25454472e0.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.peacom.co/send-bulk-contact-message-25454473e0.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) - Channel Onboard [Generate token for onboarding Whatsapp](https://doc.peacom.co/generate-token-for-onboarding-whatsapp-25454474e0.md): This API is used to Create token for onboarding channel Whatsapp. - Billing CDR [Create billing request](https://doc.peacom.co/create-billing-request-25454475e0.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.peacom.co/get-billing-request-status-25454476e0.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.peacom.co/download-billing-25454477e0.md): This API is used to Download billing in Background Task after done processing. - Summary [Get Channel Summary](https://doc.peacom.co/get-channel-summary-25454453e0.md): This API is used to Get Channel Summary on the amount of traffic of messages. - Partner > radica > Wecom [Get Wecom agent's customers](https://doc.peacom.co/get-wecom-agents-customers-25454461e0.md): This API is used to Get a WeCom's agent's customers. - Partner > radica > Wecom [Sync Wecom agent's customers](https://doc.peacom.co/sync-wecom-agents-customers-25454462e0.md): This API is used to sync WeCom's agent customers. - Partner > radica > Wecom [Send messages to Wecom customers](https://doc.peacom.co/send-messages-to-wecom-customers-25454463e0.md): This API is used to Send messages to Wecom Customers by using channel publicId. - Partner > radica > Wecom [Send messages to Wecom Customer Group](https://doc.peacom.co/send-messages-to-wecom-customer-group-25454464e0.md): This API is used to Send messages to Wecom Customer Group by using channel publicId. - Partner > radica > Wecom [Get Wecom Message Status](https://doc.peacom.co/get-wecom-message-status-25454446e0.md): This API is used to Get WeCom message status by clientMessageId (Only for our dear Radica Partner) ## Schemas - [ChannelTestRequest](https://doc.peacom.co/channeltestrequest-11579918d0.md): - [ChannelTestResponse](https://doc.peacom.co/channeltestresponse-11579919d0.md): - [CheckPhoneCapabilitiesResponse](https://doc.peacom.co/checkphonecapabilitiesresponse-11579920d0.md): - [OnboardRequest](https://doc.peacom.co/onboardrequest-11579921d0.md): - [OnboardResponse](https://doc.peacom.co/onboardresponse-11579922d0.md): - [UpdateCompanyProfileRequest](https://doc.peacom.co/updatecompanyprofilerequest-11579923d0.md): - [UpdateCompanyProfileResponse](https://doc.peacom.co/updatecompanyprofileresponse-11579924d0.md): - [CreateAPIKeyRequest](https://doc.peacom.co/createapikeyrequest-11579925d0.md): - [CreateAPIKeyResponse](https://doc.peacom.co/createapikeyresponse-11579926d0.md): - [PartnerMessageType](https://doc.peacom.co/partnermessagetype-11579927d0.md): - [MessageType](https://doc.peacom.co/messagetype-11579928d0.md): - [Status](https://doc.peacom.co/status-11579929d0.md): - [TemplateStatus](https://doc.peacom.co/templatestatus-11579930d0.md): - [TemplateMessage](https://doc.peacom.co/templatemessage-11579931d0.md): - [BroadcastSubscriberMessage](https://doc.peacom.co/broadcastsubscribermessage-11579932d0.md): - [BroadcastSubscriberGroupMessage](https://doc.peacom.co/broadcastsubscribergroupmessage-11579933d0.md): - [CreateOrEditChannelRequest](https://doc.peacom.co/createoreditchannelrequest-11579934d0.md): - [LaunchChannelRequest](https://doc.peacom.co/launchchannelrequest-11579935d0.md): - [LaunchChannelRequestIndonesia](https://doc.peacom.co/launchchannelrequestindonesia-11579936d0.md): - [LaunchChannelRequestIndia](https://doc.peacom.co/launchchannelrequestindia-11579937d0.md): - [CheckBulkPhonesRequest](https://doc.peacom.co/checkbulkphonesrequest-11579938d0.md): - [SendMessageBroadcast](https://doc.peacom.co/sendmessagebroadcast-11579939d0.md): - [TextMessage](https://doc.peacom.co/textmessage-11579940d0.md): - [TextMessageWithAttachment](https://doc.peacom.co/textmessagewithattachment-11579941d0.md): - [RichLink](https://doc.peacom.co/richlink-11579942d0.md): - [ListPicker](https://doc.peacom.co/listpicker-11579943d0.md): - [QuickReply](https://doc.peacom.co/quickreply-11579944d0.md): - [FileMessage](https://doc.peacom.co/filemessage-11579945d0.md): - [SuggestionActionType](https://doc.peacom.co/suggestionactiontype-11579946d0.md): - [Suggestion](https://doc.peacom.co/suggestion-11579947d0.md): - [RichCard](https://doc.peacom.co/richcard-11579948d0.md): - [RCSRichCard](https://doc.peacom.co/rcsrichcard-11579949d0.md): - [ViberRichCard](https://doc.peacom.co/viberrichcard-11579950d0.md): - [ViberBotRichCard](https://doc.peacom.co/viberbotrichcard-11579951d0.md): - [FBWhatsappInteractiveHeaderText](https://doc.peacom.co/fbwhatsappinteractiveheadertext-11579952d0.md): - [FBWhatsappInteractiveHeaderMedia](https://doc.peacom.co/fbwhatsappinteractiveheadermedia-11579953d0.md): - [FBWhatsappInteractive](https://doc.peacom.co/fbwhatsappinteractive-11579954d0.md): - [FBWhatsappInteractiveButton](https://doc.peacom.co/fbwhatsappinteractivebutton-11579955d0.md): - [FBWhatsappInteractiveList](https://doc.peacom.co/fbwhatsappinteractivelist-11579956d0.md): - [WhatsappFormCreateTemplateMessage](https://doc.peacom.co/whatsappformcreatetemplatemessage-11579957d0.md): - [CreateFormTemplateMessage](https://doc.peacom.co/createformtemplatemessage-11579958d0.md): - [ResponseCreateTemplateMessage](https://doc.peacom.co/responsecreatetemplatemessage-11579959d0.md): - [ResponseGetTemplate](https://doc.peacom.co/responsegettemplate-11579960d0.md): - [ListSubscriberResponseMessage](https://doc.peacom.co/listsubscriberresponsemessage-11579961d0.md): - [BroadcastResponseMessage](https://doc.peacom.co/broadcastresponsemessage-11579962d0.md): - [ChannelResponse](https://doc.peacom.co/channelresponse-11579963d0.md): - [ResponseMessage](https://doc.peacom.co/responsemessage-11579964d0.md): - [ResponseStatusMessage](https://doc.peacom.co/responsestatusmessage-11579965d0.md): - [ResponseSummaryChannelRCS](https://doc.peacom.co/responsesummarychannelrcs-11579966d0.md): - [BulkCampaignBroadcastRequest](https://doc.peacom.co/bulkcampaignbroadcastrequest-11579967d0.md): - [BulkCampaignBroadcastRequestMessage](https://doc.peacom.co/bulkcampaignbroadcastrequestmessage-11579968d0.md): - [BulkCampaignSearchResponse](https://doc.peacom.co/bulkcampaignsearchresponse-11579969d0.md): - [BulkCampaign](https://doc.peacom.co/bulkcampaign-11579970d0.md): - [BulkCampaignStatus](https://doc.peacom.co/bulkcampaignstatus-11579971d0.md): - [BulkCampaignType](https://doc.peacom.co/bulkcampaigntype-11579972d0.md): - [BulkCampaignBroadcastResponse](https://doc.peacom.co/bulkcampaignbroadcastresponse-11579973d0.md): - [BulkCampaignContact](https://doc.peacom.co/bulkcampaigncontact-11579974d0.md): - [BulkCampaignConversationRequest](https://doc.peacom.co/bulkcampaignconversationrequest-11579975d0.md): - [BulkCampaignConversationResponse](https://doc.peacom.co/bulkcampaignconversationresponse-11579976d0.md): - [ChanelOnboardGenerateTokenRequest](https://doc.peacom.co/chanelonboardgeneratetokenrequest-11579977d0.md): - [ChanelOnboardGenerateTokenResponse](https://doc.peacom.co/chanelonboardgeneratetokenresponse-11579978d0.md): - [ErrorMessage](https://doc.peacom.co/errormessage-11579979d0.md): - [Application](https://doc.peacom.co/application-11579980d0.md): - [PartnerEvent](https://doc.peacom.co/partnerevent-11579981d0.md): - [ResponseChannelInfo](https://doc.peacom.co/responsechannelinfo-11579982d0.md): - [ResponseChannelRCSLaunchInfo](https://doc.peacom.co/responsechannelrcslaunchinfo-11579983d0.md): - [CheckBulkPhonesResponse](https://doc.peacom.co/checkbulkphonesresponse-11579984d0.md): - [ResponseListApproveTemplate](https://doc.peacom.co/responselistapprovetemplate-11579985d0.md): - [RCSConversationParams](https://doc.peacom.co/rcsconversationparams-11579986d0.md): - [ViberBotConversationParams](https://doc.peacom.co/viberbotconversationparams-11579987d0.md): - [ViberConversationParams](https://doc.peacom.co/viberconversationparams-11579988d0.md): - [AppleConversationParams](https://doc.peacom.co/appleconversationparams-11579989d0.md): - [WhatsappConversationParams](https://doc.peacom.co/whatsappconversationparams-11579990d0.md): - [CommonGetChannelStatusResponse](https://doc.peacom.co/commongetchannelstatusresponse-11579991d0.md): - [WhatsappChannelStatusResponse](https://doc.peacom.co/whatsappchannelstatusresponse-11579992d0.md): - [ChannelStatus](https://doc.peacom.co/channelstatus-11579993d0.md): - [Attachment](https://doc.peacom.co/attachment-11579994d0.md): - [AttachmentImage](https://doc.peacom.co/attachmentimage-11579995d0.md): - [AttachmentLink](https://doc.peacom.co/attachmentlink-11579996d0.md): - [AttachmentMiniProgram](https://doc.peacom.co/attachmentminiprogram-11579997d0.md): - [AttachmentVideo](https://doc.peacom.co/attachmentvideo-11579998d0.md): - [AttachmentFile](https://doc.peacom.co/attachmentfile-11579999d0.md): - [backgroundTask](https://doc.peacom.co/backgroundtask-11580000d0.md): - [ZaloRequestConsentRequest](https://doc.peacom.co/zalorequestconsentrequest-11580001d0.md): - [ZaloCheckConsentResponse](https://doc.peacom.co/zalocheckconsentresponse-11580002d0.md): - [ZaloRequestConsentResponse](https://doc.peacom.co/zalorequestconsentresponse-11580003d0.md):