{"openapi":"3.0.0","info":{"description":"MSG91 messaging platform API v5: SMS flows and templates, OTP send/verify/resend and widgets, WhatsApp outbound and group messaging with templates, RCS rich cards and templates, email sends with templates, voice calls and IVR, contact phonebooks (Segmento), campaigns, the Hello helpdesk channels/tickets, and subaccount management (MSG91)","version":"v5"},"servers":[{"description":"MSG91 messaging platform API v5: SMS flows and templates, OTP send/verify/resend and widgets, WhatsApp outbound and group messaging with templates, RCS rich cards and templates, email sends with templates, voice calls and IVR, contact phonebooks (Segmento), campaigns, the Hello helpdesk channels/tickets, and subaccount management (MSG91)","url":"https://api.apirails.com/msg91"}],"paths":{"/api/v5/campaign/api/campaigns/{campaign_slug}/run":{"post":{"tags":["SMS Messaging"],"parameters":[{"name":"campaign_slug","in":"path","description":"Campaign Slug","required":true,"schema":{"type":"string","example":""}},{"name":"schedule_for","in":"query","description":"Schedule For","required":true,"schema":{"type":"string","example":""}},{"name":"timezone","in":"query","description":"Timezone","required":true,"schema":{"type":"string","example":""}},{"name":"timezone_by","in":"query","description":"Timezone By","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/campaign/run-campaign","api_endpoint":"https://control.msg91.com/api/v5/campaign/api/campaigns/{campaign_slug}/run"},"summary":"Launch Campaign","description":"Launch Campaign. Same endpoint also sends: Launch Campaign Base64 Var, Schedule Campaign  (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"string","description":"Data"}}},"example":{"data":"string"}}}}}},"/api/v5/segmento/api/v1/phonebooks/{pbId}/communications/api":{"post":{"tags":["Campaign"],"parameters":[{"name":"pbId","in":"path","description":"Pbid","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/campaign/launch-campaign--for-specific-segment-","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/phonebooks/<pb-id>/communications/api"},"summary":"Launch Campaign (For specific Segment)","description":"Launch Campaign (For specific Segment).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"meta":{"type":"object","description":"Meta","properties":{"handle_bar_support":{"type":"boolean","description":"Handle Bar Support","enum":[true,false]},"validate_email":{"type":"boolean","description":"Validate Email","enum":[true,false]}}},"campaign_slug":{"type":"string","description":"Campaign Slug Value, which can found from campaign section"},"mappings":{"type":"object","description":"Mappings","properties":{"mobiles":{"type":"string","description":"Mobiles"},"to":{"type":"string","description":"To"}}},"segment_id":{"type":"string","description":"Segment ID on which you want to launch campaign , can be found in segmento section"},"variables":{"type":"object","description":"Variables","properties":{"var":{"type":"string","description":"Var"},"var2":{"type":"object","description":"Var2"}}}}},"example":{"meta":{},"campaign_slug":"","mappings":{},"segment_id":"","variables":{}}}}}}},"/api/v5/flow":{"post":{"tags":["SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/sms/send-sms","api_endpoint":"https://control.msg91.com/api/v5/flow"},"summary":"Send SMS","description":"Send SMS.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"realTimeResponse":{"type":"string","description":"This parameter provides a real-time response in the second instance due to caching, addressing most API error codes."},"recipients":{"type":"array","description":"Recipients","items":{"type":"object","properties":{"VAR1":{"type":"string","description":"Variable is case sensitive which means in your template if your defined variable as ##var1## in API as well you should pass it as var1"},"VAR2":{"type":"string","description":"Variable is case sensitive which means in your template if your defined variable as ##var1## in API as well you should pass it as var1"},"mobiles":{"type":"string","description":"Keep number in international format (with country code)"}}}},"short_url":{"type":"string","description":"Short Url"},"short_url_expiry":{"type":"string","description":"Short Url Expiry"},"template_id":{"type":"string","description":"Template Id"}}},"example":{"realTimeResponse":"string","recipients":[],"short_url":"string","short_url_expiry":"string","template_id":"string"}}}}}},"/api/v5/sms/addTemplate":{"post":{"tags":["SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/sms/add-flow","api_endpoint":"https://control.msg91.com/api/v5/sms/addTemplate"},"summary":"Add Template","description":"Add Template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"dlt_template_id":{"type":"string","description":"If you fall in the DLT criteria of India, enter your DLT Template ID.","required":true},"sender_id":{"type":"string","description":"Sender ID for your SMS content","required":true},"smsType":{"type":"string","description":"For English - NORMAL; For unicode content - UNICODE","required":true},"template":{"type":"string","description":"Template","required":true},"template_name":{"type":"string","description":"Template Name","required":true}}},"example":{"dlt_template_id":"string","sender_id":"Sender ID","smsType":"NORMAL","template":"Type your SMS content here.","template_name":"Type Template Name"}}}}}},"/api/v5/sms/addTemplateVersion":{"post":{"tags":["SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/sms/add-template-version","api_endpoint":"https://control.msg91.com/api/v5/sms/addTemplateVersion"},"summary":"Add Template Version","description":"Add Template Version.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"dlt_template_id":{"type":"string","description":"If you fall in the DLT criteria of India, enter your DLT Template ID.","required":true},"sender_id":{"type":"string","description":"Sender Id","required":true},"template":{"type":"string","description":"Template","required":true},"template_id":{"type":"string","description":"Existing Template ID whose version is being created","required":true}}},"example":{"dlt_template_id":"string","sender_id":"string","template":"string","template_id":"string"}}}}}},"/api/v5/sms/getTemplateVersions":{"post":{"tags":["SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/sms/get-template-versions","api_endpoint":"https://control.msg91.com/api/v5/sms/getTemplateVersions"},"summary":"Get Template Details","description":"Get Template Details.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"template_id":{"type":"string","description":"Template Id"}}},"example":{"template_id":"SMS Template ID from MSG91"}}}}}},"/api/v5/sms/markActive":{"get":{"tags":["SMS"],"parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string","example":""}},{"name":"template_id","in":"query","description":"Template Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/sms/mark-default","api_endpoint":"https://control.msg91.com/api/v5/sms/markActive"},"summary":"Mark Default","description":"Mark Default.","security":[{"bearerAuth":[]}]}},"/api/v5/report/logs/p/sms":{"post":{"tags":["SMS"],"parameters":[{"name":"endDate","in":"query","description":"Range for Start Date and End Date is 3 days (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"To get specific fields data in response, supported values - requestDate, status, deliveryDate, deliveryTime, telNum, requestId, senderId, failureReason, statusCode, credit, smsLength, noOfSMS, userCredit, campaignName, scheduleDateTime, msgData, route, DLT_TE_ID, flowID, pauseReason. (accepts comma separated values; without any space after comma)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"By default it will give the telnum 1000 so you can increase the limit as per your use-case. for ex 1000000","required":false,"schema":{"type":"string","example":""}},{"name":"requestId","in":"query","description":"Unique request ID of your SMS submission","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Please ensure the Start Date is within the last 3 days(YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/sms/sms-logs","api_endpoint":"https://control.msg91.com/api/v5/report/logs/p/sms"},"summary":"SMS Logs","description":"SMS Logs.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v5/report/analytics/p/sms":{"get":{"tags":["SMS"],"parameters":[{"name":"endDate","in":"query","description":"Maximum duration supported - Last 31 days. Supported format yyyy-mm-dd","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Kindly use the Start Date from 1st Jan 2024. Supported format yyyy-mm-dd","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/sms/sms-analytics","api_endpoint":"https://control.msg91.com/api/v5/report/analytics/p/sms"},"summary":"SMS Analytics","description":"SMS Analytics.","security":[{"bearerAuth":[]}]}},"/api/v5/otp":{"post":{"tags":["OTP"],"parameters":[{"name":"invisible","in":"query","description":"For MOBILE APP only (do not use for Browsers); 1 for ON, 0 for OFF; Mobile Number Automatically Verified if its Mobile Network is ON","required":false,"schema":{"type":"string","example":""}},{"name":"mobile","in":"query","description":"Keep number in international format (with country code)","required":true,"schema":{"type":"string","example":""}},{"name":"otp","in":"query","description":"OTP you want to send","required":false,"schema":{"type":"string","example":""}},{"name":"otp_expiry","in":"query","description":"Mention the OTP expiry figures in minutes (default : 15 (Minutes); Max: 10080 (minutes)[7 days]; minimum: 1 (minute)","required":false,"schema":{"type":"string","example":""}},{"name":"otp_length","in":"query","description":"Number of digits in OTP (default : 4, min : 4, max : 9)","required":false,"schema":{"type":"string","example":""}},{"name":"realTimeResponse","in":"query","description":"Enter 1 as this parameter provides a real-time response in the second instance due to caching, addressing most API error codes.","required":false,"schema":{"type":"string","example":""}},{"name":"template_id","in":"query","description":"OTP Template id -> You will get it from OTP section of MSG91","required":true,"schema":{"type":"string","example":""}},{"name":"unicode","in":"query","description":"Enter 1 if sending SMS in languages other than English, for english pass 0","required":false,"schema":{"type":"string","example":""}},{"name":"userip","in":"query","description":"User IP","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp/sendotp","api_endpoint":"https://control.msg91.com/api/v5/otp"},"summary":"SendOTP","description":"SendOTP.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Param1":{"type":"string","description":"Variable is case sensitive which means in your template if your defined variable as ##var1## in API as well you should pass it as var1"},"Param2":{"type":"string","description":"Variable is case sensitive which means in your template if your defined variable as ##var1## in API as well you should pass it as var1"},"Param3":{"type":"string","description":"Variable is case sensitive which means in your template if your defined variable as ##var1## in API as well you should pass it as var1"}}},"example":{"Param1":"string","Param2":"string","Param3":"string"}}}}}},"/api/v5/otp/verify":{"get":{"tags":["OTP"],"parameters":[{"name":"mobile","in":"query","description":"Mobile","required":true,"schema":{"type":"string","example":""}},{"name":"otp","in":"query","description":"Otp","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp/verify-otp","api_endpoint":"https://control.msg91.com/api/v5/otp/verify"},"summary":"Verify OTP (OTP)","description":"Verify OTP.","security":[{"bearerAuth":[]}]}},"/api/v5/otp/retry":{"get":{"tags":["OTP"],"parameters":[{"name":"mobile","in":"query","description":"Keep number in international format (with country code)","required":true,"schema":{"type":"string","example":""}},{"name":"retrytype","in":"query","description":"Default - Voice, For text it should be text","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp/resend-otp","api_endpoint":"https://control.msg91.com/api/v5/otp/retry"},"summary":"Resend OTP","description":"Resend OTP.","security":[{"bearerAuth":[]}]}},"/api/v5/otp/updateOtpTemplate":{"post":{"tags":["OTP"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp/edit-otp-template","api_endpoint":"https://control.msg91.com/api/v5/otp/updateOtpTemplate"},"summary":"Edit OTP Template","description":"Edit OTP Template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dltTemplateId":{"type":"string","description":"Dlt Template Id"},"senderId":{"type":"string","description":"Sender Id"},"template":{"type":"string","description":"Template"},"templateId":{"type":"string","description":"Template Id"}}},"example":{"dltTemplateId":"string","senderId":"string","template":"string","templateId":"string"}}}}}},"/api/v5/report/logs/p/otp":{"get":{"tags":["OTP"],"parameters":[{"name":"endDate","in":"query","description":"Range for Start Date and End Date is 3 days (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"To get specific fields data in response, supported values - requestDate, status, deliveryDate, deliveryTime, telNum, requestId, senderId, failureReason, statusCode, credit, smsLength, noOfSMS, userCredit, campaignName, scheduleDateTime, msgData, route, DLT_TE_ID, templateID, pauseReason. (accepts comma separated values; without any space after comma)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"By default it will give the telnum 1000 so you can increase the limit as per your use-case. for ex 1000000","required":false,"schema":{"type":"string","example":""}},{"name":"requestId","in":"query","description":"Unique request ID of your SMS submission","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Please ensure the Start Date is within the last 3 days(YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp/otp-logs","api_endpoint":"https://control.msg91.com/api/v5/report/logs/p/otp"},"summary":"OTP Logs","description":"OTP Logs.","security":[{"bearerAuth":[]}]}},"/api/v5/report/analytics/p/otp":{"get":{"tags":["OTP"],"parameters":[{"name":"endDate","in":"query","description":"Description: Maximum duration supported - Last 31 days. Supported format yyyy-mm-dd","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Description: Kindly use the Start Date from 1st Jan 2024. Supported format yyyy-mm-dd","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp/otp-analytics","api_endpoint":"https://control.msg91.com/api/v5/report/analytics/p/otp"},"summary":"OTP Analytics","description":"OTP Analytics.","security":[{"bearerAuth":[]}]}},"/api/v5/widget/sendOtp":{"post":{"tags":["OTP Widget"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp-widget/send-otp-1","api_endpoint":"https://control.msg91.com/api/v5/widget/sendOtp"},"summary":"Send OTP","description":"Send OTP.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"identifier":{"type":"string","description":"Identifier"},"widgetId":{"type":"string","description":"Widget Id"}}},"example":{"identifier":"email@gmail.com or mobile-no","widgetId":""}}}}}},"/api/v5/widget/retryOtp":{"post":{"tags":["OTP Widget"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp-widget/retry-otp","api_endpoint":"https://control.msg91.com/api/v5/widget/retryOtp"},"summary":"Retry OTP","description":"Retry OTP.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"reqId":{"type":"string","description":"Req Id"},"retryChannel":{"type":"string","description":"Retry Channel"},"widgetId":{"type":"string","description":"Widget Id"}}},"example":{"reqId":"requestId from send OTP response","retryChannel":"channel_id (optional)","widgetId":""}}}}}},"/api/v5/widget/verifyOtp":{"post":{"tags":["OTP Widget"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp-widget/verify-otp","api_endpoint":"https://control.msg91.com/api/v5/widget/verifyOtp"},"summary":"Verify OTP (OTP Widget)","description":"Verify OTP.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"otp":{"type":"string","description":"Otp"},"reqId":{"type":"string","description":"Req Id"},"widgetId":{"type":"string","description":"Widget Id"}}},"example":{"otp":"client OTP","reqId":"requestId from send OTP response","widgetId":""}}}}}},"/api/v5/widget/verifyAccessToken":{"post":{"tags":["OTP Widget"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp-widget/verify-access-token","api_endpoint":"https://control.msg91.com/api/v5/widget/verifyAccessToken"},"summary":"Verify Access Token","description":"Verify Access Token.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"access-token":{"type":"string","description":"Access-Token"}}},"example":{"access-token":"JWT access_token from verify OTP API"}}}}}},"/api/v5/report/logs/p/widget":{"get":{"tags":["OTP Widget"],"parameters":[{"name":"endDate","in":"query","description":"Please ensure the Start Date is within the last 3 days(YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Range for Start Date and End Date is 3 days (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"verifystatus","in":"query","description":"true,false","required":false,"schema":{"type":"string","example":""}},{"name":"widgetId","in":"query","description":"Your MSG91 Widget ID","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp-widget/widget-logs","api_endpoint":"https://control.msg91.com/api/v5/report/logs/p/widget"},"summary":"Widget Logs","description":"Widget Logs.","security":[{"bearerAuth":[]}]}},"/api/v5/report/analytics/p/widget":{"get":{"tags":["OTP Widget"],"parameters":[{"name":"endDate","in":"query","description":"Maximum duration supported - Last 31 days. Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/otp-widget/widget-analytic","api_endpoint":"https://control.msg91.com/api/v5/report/analytics/p/widget"},"summary":"Widget Analytics","description":"Widget Analytics.","security":[{"bearerAuth":[]}]}},"/api/v5/email/validate":{"post":{"tags":["Email"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/email/email-validation","api_endpoint":"https://control.msg91.com/api/v5/email/validate"},"summary":"Email Validation","description":"Email Validation.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email"}}},"example":{"email":"string"}}}}}},"/api/v5/email/send":{"post":{"tags":["Email"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/email/send-email","api_endpoint":"https://control.msg91.com/api/v5/email/send"},"summary":"Send Email","description":"Send Email. Same endpoint also sends: Send Email with CSV, Send Email with validation, Sending Emails Using Handlebars (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attachments":{"type":"array","description":"Attachments","items":{"type":"object","properties":{"fileName":{"type":"string","description":"File Name"},"filePath":{"type":"string","description":"File Path"}}}},"domain":{"type":"string","description":"Domain"},"from":{"type":"object","description":"From","properties":{"email":{"type":"string","description":"Email"},"name":{"type":"string","description":"Name"}}},"recipients":{"type":"array","description":"Recipients","items":{"type":"object","properties":{"to":{"type":"array","description":"To"},"variables":{"type":"object","description":"Variables"}}}},"reply_to":{"type":"array","description":"Reply To","items":{"type":"object","properties":{"email":{"type":"string","description":"Email"}}}},"template_id":{"type":"string","description":"Template Id"}}},"example":{"attachments":[],"domain":"string","from":{},"recipients":[],"reply_to":[],"template_id":"string"}}}}}},"/api/v5/email/templates":{"post":{"tags":["Email"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/email/create-new-template","api_endpoint":"https://control.msg91.com/api/v5/email/templates"},"summary":"Create HTML Template","description":"Create HTML Template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"Body"},"files":{"type":"array","description":"Files","items":{"type":"string"}},"name":{"type":"string","description":"Name"},"slug":{"type":"string","description":"Slug"},"subject":{"type":"string","description":"Subject"}}},"example":{"body":"string","files":[],"name":"string","slug":"string","subject":"string"}}}}},"get":{"tags":["Email"],"parameters":[{"name":"keyword","in":"query","description":"Keywords to search","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Number of pages","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Templates per page","required":false,"schema":{"type":"string","example":""}},{"name":"search_in","in":"query","description":"To search in template name","required":false,"schema":{"type":"string","example":""}},{"name":"status_id","in":"query","description":"1 for Pending, 2 for verified, 5 for rejected","required":false,"schema":{"type":"string","example":""}},{"name":"with","in":"query","description":"If you need versions as well","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/email/list-of-all-email-templates","api_endpoint":"https://control.msg91.com/api/v5/email/templates"},"summary":"Get Email Templates","description":"Get Email Templates.","security":[{"bearerAuth":[]}]}},"/api/v5/email/services/inline-css":{"post":{"tags":["Email"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/email/template-css-inliner","api_endpoint":"https://control.msg91.com/api/v5/email/services/inline-css"},"summary":"Template Css Inliner","description":"Template Css Inliner.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"html":{"type":"string","description":"Html"}}},"example":{"html":"string"}}}}}},"/api/v5/email/template-versions/{TemplateVersionIdHere}":{"get":{"tags":["Email"],"parameters":[{"name":"TemplateVersionIdHere","in":"path","description":"Template Version Id Here","required":true,"schema":{"type":"string","example":""}},{"name":"with","in":"query","description":"With","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/email/email-template-details","api_endpoint":"https://control.msg91.com/api/v5/email/template-versions/{TemplateVersionIdHere}"},"summary":"Template Version Details","description":"Template Version Details.","security":[{"bearerAuth":[]}]}},"/api/v5/report/logs/mail":{"get":{"tags":["Email"],"parameters":[{"name":"endDate","in":"query","description":"Range for Start Date and End Date is 3 days (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"To get specific fields data in response, supported values - createdAt, domain, statusUpdatedAt, statusUpdatedAt, recipientEmail, requestId, senderEmail, failureReason,status,description,campaignName,mailType,subject(accepts comma separated values; without any space after comma)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"By default it will give the emails 1000 so you can increase the limit as per your use-case. for ex 1000000","required":false,"schema":{"type":"string","example":""}},{"name":"requestId","in":"query","description":"Unique request ID of your Email submission","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Please ensure the Start Date is within the last 3 days(YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/email/email-logs","api_endpoint":"https://control.msg91.com/api/v5/report/logs/mail"},"summary":"Email Logs","description":"Email Logs.","security":[{"bearerAuth":[]}]}},"/api/v5/report/analytics/p/mail":{"get":{"tags":["Email"],"parameters":[{"name":"endDate","in":"query","description":"Maximum duration supported - Last 31 days. Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/email/email-analytics","api_endpoint":"https://control.msg91.com/api/v5/report/analytics/p/mail"},"summary":"Email Analytics","description":"Email Analytics.","security":[{"bearerAuth":[]}]}},"/api/v5/whatsapp/client-panel-template":{"post":{"tags":["WhatsApp"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/create-whatsapp-template","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/client-panel-template"},"summary":"Create Template (WhatsApp)","description":"Create Template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"string","description":"Template categories could be - Authentication, Marketing, Utility"},"button_url":{"type":"boolean","description":"Enable or Disable click count","enum":[true,false]},"components":{"type":"array","description":"Components","items":{"type":"object","properties":{"text":{"type":"string","description":"Text"},"type":{"type":"string","description":"Type"},"example":{"type":"object","description":"Example"},"format":{"type":"string","description":"Format"}}}},"integrated_number":{"type":"string","description":"Your integrated WhatsApp number"},"language":{"type":"string","description":"Language could be - en_US; Check all supported languages https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/supported-languages"},"template_name":{"type":"string","description":"Give your template a name"}}},"example":{"category":"string","button_url":"","components":[],"integrated_number":"string","language":"string","template_name":"string"}}}}},"delete":{"tags":["WhatsApp"],"parameters":[{"name":"integrated_number","in":"query","description":"Integrated Number","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"query","description":"Template Name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/delete-template","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/client-panel-template"},"summary":"Delete Template","description":"Delete Template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v5/whatsapp/whatsapp-outbound-message/bulk":{"post":{"tags":["WhatsApp"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/template-bulk","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/whatsapp-outbound-message/bulk"},"summary":"Send WhatsApp Template","description":"Send WhatsApp Template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content_type":{"type":"string","description":"Content Type"},"integrated_number":{"type":"string","description":"Integrated Number"},"payload":{"type":"object","description":"Payload","properties":{"type":{"type":"string","description":"Type"},"messaging_product":{"type":"string","description":"Messaging Product"},"template":{"type":"object","description":"Template"}}}}},"example":{"content_type":"string","integrated_number":"string","payload":{}}}}}}},"/api/v5/whatsapp/whatsapp-outbound-message":{"post":{"tags":["WhatsApp"],"parameters":[{"name":"text","in":"query","description":"Message content","required":true,"schema":{"type":"string","example":""}},{"name":"content_type","in":"query","description":"text, image , video , reaction , location","required":true,"schema":{"type":"string","example":""}},{"name":"integrated_number","in":"query","description":"Integrated WhatsApp Number, with country code","required":true,"schema":{"type":"string","example":""}},{"name":"recipient_number","in":"query","description":"Mobile Number with country code","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/send-message-in-text","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/whatsapp-outbound-message"},"summary":"Send Message (once Session Started)","description":"Send Message (once Session Started). Same endpoint also sends: Interactive Wa Send Location, Interactive Wa With Buttons, Interactive Wa With List, Multiple Product Catalog, Send Message on Group, Send Payment link via Whatsapp Payments, Single Product Catalog (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v5/whatsapp/whatsapp-activation":{"get":{"tags":["WhatsApp"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/to-fetch-whatsapp-number","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/whatsapp-activation"},"summary":"To Fetch Whatsapp Number","description":"To Fetch Whatsapp Number.","security":[{"bearerAuth":[]}]}},"/api/v5/whatsapp/get-template-client/{number}":{"get":{"tags":["WhatsApp"],"parameters":[{"name":"number","in":"path","description":"Number","required":true,"schema":{"type":"string","example":""}},{"name":"page_num","in":"query","description":"1/2/3 etc","required":true,"schema":{"type":"string","example":""}},{"name":"page_size","in":"query","description":"25/30/50/100/200 etc","required":true,"schema":{"type":"string","example":""}},{"name":"pagination","in":"query","description":"Can be set as true or empty (If any one of the parameters is missing or passed as an empty string, the API response will return non-paginated data)","required":true,"schema":{"type":"string","example":""}},{"name":"template_language","in":"query","description":"Optional - Language of the template","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"query","description":"Optional - Name of WhatsApp Template","required":true,"schema":{"type":"string","example":""}},{"name":"template_status","in":"query","description":"Optional - approved, rejected or pending.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/get-templates","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/get-template-client/{number}"},"summary":"Get Templates","description":"Get Templates.","security":[{"bearerAuth":[]}]}},"/api/v5/whatsapp/client-panel-template/template_id":{"put":{"tags":["WhatsApp"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/edit-template-1","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/client-panel-template/template_id"},"summary":"Edit Template","description":"Edit Template. Same endpoint also sends: Edit Template (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"button_url":{"type":"boolean","description":"Button Url","enum":[true,false]},"components":{"type":"array","description":"Components","items":{"type":"object","properties":{"text":{"type":"string","description":"Text"},"type":{"type":"string","description":"Type"}}}},"integrated_number":{"type":"string","description":"Integrated Number"}}},"example":{"button_url":"","components":[],"integrated_number":"919xxxxxxxxx"}}}}}},"/api/v5/whatsapp/integrated-number/call-settings":{"post":{"tags":["WhatsApp"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/whatsapp-voice-call","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/integrated-number/call-settings"},"summary":"WhatsApp Voice Call","description":"WhatsApp Voice Call.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"call_hours":{"type":"object","description":"Call Hours","properties":{"holiday_schedule":{"type":"array","description":"Holiday Schedule"},"status":{"type":"string","description":"ENABLED\" or \"DISABLED"},"timezone_id":{"type":"string","description":"A valid IANA time zone ID"},"weekly_operating_hours":{"type":"array","description":"Weekly Operating Hours"}}},"status":{"type":"string","description":"ENABLED\" or \"DISABLED"}}},"example":{"call_hours":{},"status":"ENABLED"}}}}}},"/api/v5/subscriptions/fetchPrepaidBalance":{"post":{"tags":["WhatsApp"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/check-whatsapp-prepaid-balance","api_endpoint":"https://control.msg91.com/api/v5/subscriptions/fetchPrepaidBalance"},"summary":"Check WhatsApp Prepaid Balance","description":"Check WhatsApp Prepaid Balance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"integrated_number":{"type":"string","description":"Integrated Number"},"service":{"type":"string","description":"Service"}}},"example":{"integrated_number":"15550236673","service":"whatsapp"}}}}}},"/api/v5/report/logs/wa":{"get":{"tags":["WhatsApp"],"parameters":[{"name":"endDate","in":"query","description":"Range for Start Date and End Date is 3 days (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"To get specific fields data in response, supported values -requestedAt ,requestId, price, origin, failureReason, status, sentTime, deliveryTime, uuid, integratedNumber, customerNumber, messageType, direction, content, templateName, campaignName, totalClicked, CRQID. (accepts comma separated values; without any space after comma)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"By default it will give the telnum 1000 so you can increase the limit as per your use-case. for ex 1000000","required":false,"schema":{"type":"string","example":""}},{"name":"requestId","in":"query","description":"Unique request ID of your SMS submission","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Please ensure the Start Date is within the last 3 days(YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/whatsapp-logs","api_endpoint":"https://control.msg91.com/api/v5/report/logs/wa"},"summary":"Whatsapp Logs","description":"Whatsapp Logs.","security":[{"bearerAuth":[]}]}},"/api/v5/report/analytics/p/wa":{"get":{"tags":["WhatsApp"],"parameters":[{"name":"endDate","in":"query","description":"Maximum duration supported - Last 31 days. Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/whatsapp-analytics","api_endpoint":"https://control.msg91.com/api/v5/report/analytics/p/wa"},"summary":"WhatsApp Analytics","description":"WhatsApp Analytics.","security":[{"bearerAuth":[]}]}},"/api/v5/whatsapp/groups":{"get":{"tags":["WhatsApp"],"parameters":[{"name":"integrated_number","in":"query","description":"WhatsApp Integrated Number","required":true,"schema":{"type":"string","example":""}},{"name":"timezone","in":"query","description":"Timezone in Encoded format","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/get-group-by-number","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups"},"summary":"Get Group by Number","description":"Get Group by Number.","security":[{"bearerAuth":[]}]},"post":{"tags":["WhatsApp"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/create-group","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups"},"summary":"Create Group","description":"Create Group.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Group Description"},"integrated_number":{"type":"string","description":"WhatsApp Integrated Number"},"join_approval_mode":{"type":"string","description":"Approval required"},"subject":{"type":"string","description":"Group Name"}}},"example":{"description":"string","integrated_number":"string","join_approval_mode":"string","subject":"string"}}}}},"put":{"tags":["WhatsApp"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/update-group-settings-1","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups"},"summary":"Update Group Settings","description":"Update Group Settings.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description","required":true},"integrated_number":{"type":"string","description":"Integrated Number","required":true},"profile_picture_file":{"type":"string","description":"Profile Picture File","required":true},"subject":{"type":"string","description":"Subject","required":true}}},"example":{"description":"string","integrated_number":"string","profile_picture_file":"string","subject":"string"}}}}}},"/api/v5/whatsapp/groups/{group_id}":{"get":{"tags":["WhatsApp"],"parameters":[{"name":"group_id","in":"path","description":"Group Id","required":true,"schema":{"type":"string","example":""}},{"name":"integrated_number","in":"query","description":"WhatsApp Integrated Number","required":true,"schema":{"type":"string","example":""}},{"name":"timezone","in":"query","description":"Timezone in Encoded format","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/get-group-by-id","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups/{group_id}"},"summary":"Get Group by ID","description":"Get Group by ID.","security":[{"bearerAuth":[]}]},"delete":{"tags":["WhatsApp"],"parameters":[{"name":"group_id","in":"path","description":"Group Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/delete-group","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups/{group_id}"},"summary":"Delete Group","description":"Delete Group. Same endpoint also sends: Remove participants (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"integrated_number":{"type":"string","description":"Integrated Number"}}},"example":{"integrated_number":""}}}}},"patch":{"tags":["WhatsApp"],"parameters":[{"name":"group_id","in":"path","description":"Group Id","required":true,"schema":{"type":"string","example":""}},{"name":"integrated_number","in":"query","description":"Integrated Number","required":true,"schema":{"type":"string","example":""}},{"name":"reset_group_link","in":"query","description":"Reset Group Link","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/reset-group-invite-link-1","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups/{group_id}"},"summary":"Reset Group Invite Link","description":"Reset Group Invite Link.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v5/whatsapp/groups/{group_id}/join_req":{"get":{"tags":["WhatsApp"],"parameters":[{"name":"group_id","in":"path","description":"Group Id","required":true,"schema":{"type":"string","example":""}},{"name":"integrated_number","in":"query","description":"WhatsApp Integrated Number","required":true,"schema":{"type":"string","example":""}},{"name":"timezone","in":"query","description":"Timezone in Encoded format","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/get-joinee-request","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups/{group_id}/join_req"},"summary":"Get Join Request","description":"Get Join Request.","security":[{"bearerAuth":[]}]}},"/api/v5/whatsapp/groups/{group_id}/join_requests":{"post":{"tags":["WhatsApp"],"parameters":[{"name":"group_id","in":"path","description":"Group Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/approve-join-requests","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups/{group_id}/join_requests"},"summary":"Approve Join Requests","description":"Approve Join Requests.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"integrated_number":{"type":"string","description":"Integrated Number"},"join_requests":{"type":"array","description":"Join Requests","items":{"type":"string"}}}},"example":{"integrated_number":"","join_requests":["request id"]}}}}},"delete":{"tags":["WhatsApp"],"parameters":[{"name":"group_id","in":"path","description":"Group Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/whatsapp/reject-join-requests-1","api_endpoint":"https://control.msg91.com/api/v5/whatsapp/groups/{group_id}/join_requests"},"summary":"Reject Join Requests","description":"Reject Join Requests.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"integrated_number":{"type":"string","description":"Integrated Number"},"join_requests":{"type":"array","description":"Join Requests","items":{"type":"string"}}}},"example":{"integrated_number":"","join_requests":["request_id"]}}}}}},"/api/v5/segmento/api/v1/phonebooks/{phonebook_id}/contacts":{"post":{"tags":["Contacts"],"parameters":[{"name":"phonebook_id","in":"path","description":"Phonebook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/createupdate-contact","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/phonebooks/{phonebook_id}/contacts"},"summary":"Create/update Contact","description":"Create/update Contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"input":{"type":"object","description":"Input","properties":{"contact_id":{"type":"string","description":"Contact Id"},"date_field":{"type":"string","description":"Date Field"},"details":{"type":"object","description":"Details"},"email":{"type":"string","description":"Email"},"name":{"type":"string","description":"Name"},"new_field":{"type":"string","description":"New Field"}}}}},"example":{"input":{}}}}}}},"/api/v5/segmento/api/v1/phonebooks/{phonebook_id}/contacts/filters":{"post":{"tags":["Contacts"],"parameters":[{"name":"phonebook_id","in":"path","description":"Phonebook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/filtersearch-contact","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/phonebooks/{phonebook_id}/contacts/filters"},"summary":"Filter/search Contact","description":"Filter/search Contact.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"columns":{"type":"array","description":"Columns","items":{"type":"string"}},"itemsPerPage":{"type":"number","description":"Items Per Page"},"pageNo":{"type":"number","description":"Page No"},"query":{"type":"object","description":"Query","properties":{"condition":{"type":"string","description":"Condition"},"rules":{"type":"array","description":"Rules"}}},"search":{"type":"string","description":"Search"},"sortBy":{"type":"string","description":"Sort By"},"sortOrder":{"type":"string","description":"Sort Order"},"totalPageCount":{"type":"number","description":"Total Page Count"}}},"example":{"columns":[],"itemsPerPage":1,"pageNo":1,"query":{},"search":"string","sortBy":"string","sortOrder":"string","totalPageCount":1}}}}}},"/api/v5/segmento/api/v1/phonebooks/{phonebook_Id}/contacts":{"delete":{"tags":["Contacts"],"parameters":[{"name":"phonebook_Id","in":"path","description":"Phonebook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/delete-bulk-contacts","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/phonebooks/{phonebook_Id}/contacts"},"summary":"Delete - Contacts","description":"Delete - Contacts.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_Ids":{"type":"array","description":"Contact Ids","items":{"type":"string"}}}},"example":{"contact_Ids":[]}}}}}},"/api/v5/segmento/api/v1/phonebooks/{phonebook_id}/fields":{"get":{"tags":["Contacts"],"parameters":[{"name":"phonebook_id","in":"path","description":"Phonebook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/get-phonebook-fields","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/phonebooks/{phonebook_id}/fields"},"summary":"Get Phonebook Fields","description":"Get Phonebook Fields.","security":[{"bearerAuth":[]}]}},"/api/v5/segmento/api/v1/event/{phoneBookId}":{"post":{"tags":["Contacts"],"parameters":[{"name":"phoneBookId","in":"path","description":"Phone Book Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/user-events/create-user-events","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/event/{phoneBookId}"},"summary":"Create User Events","description":"Create User Events.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"array","description":"Data","items":{"type":"object","properties":{"context":{"type":"object","description":"Context"},"event_name":{"type":"string","description":"Event Name"},"event_properties":{"type":"object","description":"Event Properties"},"event_timestamp":{"type":"string","description":"Event Timestamp"},"visitor_id":{"type":"string","description":"Visitor Id"}}}}}},"example":{"data":[]}}}}}},"/api/v5/segmento/api/v1/userEvents/{phoneBookId}":{"post":{"tags":["Contacts"],"parameters":[{"name":"phoneBookId","in":"path","description":"Phone Book Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/user-events/get-user-journey","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/userEvents/{phoneBookId}"},"summary":"User Journey","description":"User Journey.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contact_id":{"type":"string","description":"Contact Id"},"end_date":{"type":"string","description":"End Date"},"itemsPerPage":{"type":"number","description":"Items Per Page"},"pageNo":{"type":"number","description":"Page No"},"start_date":{"type":"string","description":"Start Date"}}},"example":{"contact_id":"string","end_date":"string","itemsPerPage":1,"pageNo":1,"start_date":"string"}}}}}},"/api/v5/segmento/api/v1/products/{phoneBookId}":{"get":{"tags":["Contacts"],"parameters":[{"name":"phoneBookId","in":"path","description":"Phone Book Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/user-events/get-product-catalogue","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/products/{phoneBookId}"},"summary":"Get Product Catalog","description":"Get Product Catalog.","security":[{"bearerAuth":[]}]}},"/api/v5/segmento/api/v1/failedEvents/{phoneBookId}":{"post":{"tags":["Contacts"],"parameters":[{"name":"phoneBookId","in":"path","description":"Phone Book Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/user-events/get-failed-events","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/failedEvents/{phoneBookId}"},"summary":"Get failed Events","description":"Get failed Events.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"end_date":{"type":"string","description":"End Date"},"itemsPerPage":{"type":"number","description":"Items Per Page"},"pageNo":{"type":"number","description":"Page No"},"start_date":{"type":"string","description":"Start Date"}}},"example":{"end_date":"string","itemsPerPage":1,"pageNo":1,"start_date":"string"}}}}}},"/api/v5/segmento/api/v1/eventTypes/{phoneBookId}":{"get":{"tags":["Contacts"],"parameters":[{"name":"phoneBookId","in":"path","description":"Phone Book Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/segmento/user-events/get-eventtypes","api_endpoint":"https://control.msg91.com/api/v5/segmento/api/v1/eventTypes/{phoneBookId}"},"summary":"Get EventTypes","description":"Get EventTypes.","security":[{"bearerAuth":[]}]}},"/api/v5/voice/call":{"post":{"tags":["Voice"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/send-voice-sms","api_endpoint":"https://control.msg91.com/api/v5/voice/call"},"summary":"Send Voice SMS","description":"Send Voice SMS. Same endpoint also sends: Execute An Ivr/flow To A Number (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callback_url":{"type":"string","description":"Callback Url"},"caller_id":{"type":"string","description":"Caller Id"},"client_number":{"type":"string","description":"Client Number"},"template":{"type":"string","description":"Template"},"variables":{"type":"object","description":"Variables","properties":{"var1":{"type":"object","description":"Var1"},"var2":{"type":"object","description":"Var2"}}}}},"example":{"callback_url":"string","caller_id":"string","client_number":"string","template":"string","variables":{}}}}}}},"/api/v5/voice/call/ctc":{"post":{"tags":["Voice"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/click-to-call","api_endpoint":"https://control.msg91.com/api/v5/voice/call/ctc"},"summary":"Click To Call Or 2-way Call","description":"Click To Call Or 2-way Call.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"caller_id":{"type":"string","description":"Caller Id"},"destination":{"type":"string","description":"Destination"},"destinationB":{"type":"array","description":"Destination B","items":{"type":"string"}}}},"example":{"caller_id":"string","destination":"string","destinationB":[]}}}}}},"/api/v5/voice/company-agent-list":{"get":{"tags":["Voice"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/get-company-agents","api_endpoint":"https://control.msg91.com/api/v5/voice/company-agent-list"},"summary":"Get company Agents","description":"Get company Agents.","security":[{"bearerAuth":[]}]}},"/api/v5/voice/public/sip-credentials":{"get":{"tags":["Voice"],"parameters":[{"name":"agent_id","in":"query","description":"Agent Id","required":true,"schema":{"type":"string","example":""}},{"name":"agent_username","in":"query","description":"Agent Username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/get-sip-credentials","api_endpoint":"https://control.msg91.com/api/v5/voice/public/sip-credentials"},"summary":"Get sip-credentials","description":"Get sip-credentials.","security":[{"bearerAuth":[]}]}},"/api/v5/voice/public/vpn-credentials":{"get":{"tags":["Voice"],"parameters":[{"name":"agent_id","in":"query","description":"Agent Id","required":true,"schema":{"type":"string","example":""}},{"name":"server_id","in":"query","description":"Server Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/get-vpn-credentials","api_endpoint":"https://control.msg91.com/api/v5/voice/public/vpn-credentials"},"summary":"Get VPN credentials","description":"Get VPN credentials.","security":[{"bearerAuth":[]}]}},"/api/v5/voice/call-logs":{"get":{"tags":["Voice"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/voice-logs","api_endpoint":"https://control.msg91.com/api/v5/voice/call-logs"},"summary":"Voice Logs (Voice)","description":"Voice Logs.","security":[{"bearerAuth":[]}]}},"/api/v5/voice/templates":{"get":{"tags":["Voice"],"parameters":[{"name":"id","in":"query","description":"To get details of specific template using Template ID (optional)","required":true,"schema":{"type":"string","example":""}},{"name":"page_num","in":"query","description":"page number","required":true,"schema":{"type":"string","example":""}},{"name":"page_size","in":"query","description":"number of templates per page","required":true,"schema":{"type":"string","example":""}},{"name":"sort_by","in":"query","description":"name (only)","required":true,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"asc/desc","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/get-template-1","api_endpoint":"https://control.msg91.com/api/v5/voice/templates"},"summary":"Get Template (Voice)","description":"Get Template.","security":[{"bearerAuth":[]}]},"post":{"tags":["Voice"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/create-template","api_endpoint":"https://control.msg91.com/api/v5/voice/templates"},"summary":"Create Template (Voice)","description":"Create Template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"has_variable":{"type":"boolean","description":"If you have variable pass true else false","enum":[true,false]},"name":{"type":"string","description":"Name of your Template as per your choice"},"structure":{"type":"array","description":"Structure","items":{"type":"object","properties":{"type":{"type":"string","description":"Type"},"value":{"type":"string","description":"Value"}}}},"voice_name":{"type":"string","description":"Voice name"}}},"example":{"has_variable":"","name":"string","structure":[],"voice_name":"string"}}}}}},"/api/v5/voice/files":{"get":{"tags":["Voice"],"parameters":[{"name":"page_size","in":"query","description":"Page Size","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/get-voice-file","api_endpoint":"https://control.msg91.com/api/v5/voice/files"},"summary":"Get Voice File","description":"Get Voice File.","security":[{"bearerAuth":[]}]}},"/api/v5/report/logs/voice":{"get":{"tags":["Voice"],"parameters":[{"name":"endDate","in":"query","description":"Range for Start Date and End Date is 3 days (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"To get specific fields data in response, supported values - createdAt, status, startTime, endTime, duration, charged, destination, direction, callerId, uuid, failureReason, country, billing, recording, destinationB , disconnectedBy , source (accepts comma separated values; without any space after comma)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"By default it will give the telnum 1000 so you can increase the limit as per your use-case. for ex 1000000","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Please ensure the Start Date is within the last 3 days(YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"uuid","in":"query","description":"Unique request ID of your voice submission","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/voice-logs-1","api_endpoint":"https://control.msg91.com/api/v5/report/logs/voice"},"summary":"Voice Logs (Voice 2)","description":"Voice Logs.","security":[{"bearerAuth":[]}]}},"/api/v5/report/analytics/p/voice":{"get":{"tags":["Voice"],"parameters":[{"name":"endDate","in":"query","description":"Maximum duration supported - Last 31 days. Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/voice/voice-analytic","api_endpoint":"https://control.msg91.com/api/v5/report/analytics/p/voice"},"summary":"Voice Analytics","description":"Voice Analytics.","security":[{"bearerAuth":[]}]}},"/api/v5/rcs/send-rcs-message/bulk":{"post":{"tags":["RCS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/rcs/rcs-send-message/rcs-bulk-media","api_endpoint":"https://control.msg91.com/api/v5/rcs/send-rcs-message/bulk"},"summary":"Rcs - Media","description":"Rcs - Media. Same endpoint also sends: Rcs - Calendar Event, Rcs - Carousel, Rcs - Dial, Rcs - Rich Card, Rcs - Share Location, Rcs - Suggested Replies, Rcs - Template, Rcs - View Location (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"customer_numbers":{"type":"array","description":"Customer Numbers","items":{"type":"string"}},"function_name":{"type":"string","description":"Function Name"},"media_url":{"type":"string","description":"Media Url"},"project_id":{"type":"string","description":"Project Id"},"ttl":{"type":"string","description":"Value should be greater than 1 sec to 15 days. Value should be provided in seconds only."}}},"example":{"customer_numbers":[],"function_name":"string","media_url":"string","project_id":"string","ttl":"string"}}}}}},"/api/v5/rcs/send-rcs-message":{"post":{"tags":["RCS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/rcs/rcs-send-message/rcs-bulk-open-url","api_endpoint":"https://control.msg91.com/api/v5/rcs/send-rcs-message"},"summary":"Rcs - Open Url","description":"Rcs - Open Url.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"Text"},"customer_numbers":{"type":"array","description":"Customer Numbers","items":{"type":"string"}},"function_name":{"type":"string","description":"Function Name"},"project_id":{"type":"string","description":"Project ID will be shown in MSG91 panel under Registration section"},"text_to_show":{"type":"string","description":"Text To Show"},"ttl":{"type":"string","description":"Value should be greater than 1 sec to 15 days. Value should be provided in seconds only."},"url":{"type":"string","description":"Url"}}},"example":{"text":"string","customer_numbers":[],"function_name":"string","project_id":"string","text_to_show":"string","ttl":"string","url":"string"}}}}}},"/api/v5/rcs/rcs-client-panel/template":{"post":{"tags":["RCS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/rcs/rcs-create-template-1/text-message","api_endpoint":"https://control.msg91.com/api/v5/rcs/rcs-client-panel/template"},"summary":"Text Message","description":"Text Message. Same endpoint also sends: Carousel, Carousel with video, Create Calendar Event, Dial, Open URL, Rich Card, Share Location, Suggested Replies (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"Content"},"function_name":{"type":"string","description":"Function Name"},"language":{"type":"string","description":"Language"},"project_id":{"type":"string","description":"Project Id"},"template_name":{"type":"string","description":"Template Name"}}},"example":{"content":"string","function_name":"text_message","language":"en","project_id":"1a6caf23-0c6c-4b41-8fe2-1c28bb694335","template_name":"Test"}}}}},"get":{"tags":["RCS"],"parameters":[{"name":"project_id","in":"query","description":"Project Id","required":true,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"Status","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/rcs/rcs-get-template/get-template","api_endpoint":"https://control.msg91.com/api/v5/rcs/rcs-client-panel/template"},"summary":"Get Template (RCS)","description":"Get Template.","security":[{"bearerAuth":[]}]}},"/api/v5/rcs//rcs-client-panel/template":{"post":{"tags":["RCS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/rcs/rcs-create-template-1/view-location","api_endpoint":"https://control.msg91.com/api/v5/rcs//rcs-client-panel/template"},"summary":"View Location","description":"View Location.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"Content"},"function_name":{"type":"string","description":"Function Name"},"project_id":{"type":"string","description":"Project Id"},"template_name":{"type":"string","description":"Template Name"}}},"example":{"content":"string","function_name":"view_location","project_id":"your MSG91 Project ID","template_name":"sample_template"}}}}}},"/api/v5/report/logs/rcs":{"get":{"tags":["RCS"],"parameters":[{"name":"endDate","in":"query","description":"Range for Start Date and End Date is 3 days (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"To get specific fields data in response, supported values - submittedAt, status, projectId, clientName, customerNumber, messageType, direction, failureReason, templateName, requestId, uuid, timestamp, deliveryTime, type, price, campaignRequestId, webengageMsgId, totalClicked, CRQID, referenceId. (accepts comma separated values; without any space after comma)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"By default it will give the telnum 1000 so you can increase the limit as per your use-case. for ex 1000000","required":false,"schema":{"type":"string","example":""}},{"name":"requestId","in":"query","description":"Unique request ID of your RCS submission","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Please ensure the Start Date is within the last 3 days(YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/rcs/rcs-logs","api_endpoint":"https://control.msg91.com/api/v5/report/logs/rcs"},"summary":"RCS Logs","description":"RCS Logs.","security":[{"bearerAuth":[]}]}},"/api/v5/report/analytics/rcs":{"get":{"tags":["RCS"],"parameters":[{"name":"endDate","in":"query","description":"Maximum duration supported - Last 31 days. Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/rcs/rcs-analytics","api_endpoint":"https://control.msg91.com/api/v5/report/analytics/rcs"},"summary":"RCS Analytics","description":"RCS Analytics.","security":[{"bearerAuth":[]}]}},"/api/v5/hello/v2/send":{"post":{"tags":["Hello"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/hello-mail-send-","api_endpoint":"https://control.msg91.com/api/v5/hello/v2/send"},"summary":"Hello Mail Send API","description":"Hello Mail Send API. Same endpoint also sends: Reply in Same Thread (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"Must be \"mail\" exactly (case-sensitive)"},"compose":{"type":"boolean","description":"true = new mail thread, false = reply in existing thread","enum":[true,false]},"content":{"type":"object","description":"Cannot be empty","properties":{"text":{"type":"string","description":"Maximum 500KB (500,000 characters)"},"attachment":{"type":"array","description":"Maximum 20 attachments per request"},"bcc":{"type":"array","description":"Each email must match pattern: [string]@[string].[string]"},"cc":{"type":"array","description":"Each email must match pattern: [string]@[string].[string]"},"subject":{"type":"string","description":"Maximum 998 characters (RFC 2822)"}}},"inbox_id":{"type":"number","description":"Required for new mail threads"},"message_type":{"type":"string","description":"Must be \"text-attachment\" exactly"},"to":{"type":"string","description":"Required for new mail threads"}}},"example":{"type":"string","compose":"","content":{},"inbox_id":1,"message_type":"string","to":"string"}}}}}},"/api/v5/hello/ticket-assign":{"put":{"tags":["Hello"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/assign-ticket","api_endpoint":"https://control.msg91.com/api/v5/hello/ticket-assign"},"summary":"Assign Ticket","description":"Assign Ticket.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"\"mail\", \"chat\", \"whatsapp\""},"assignee_id":{"type":"number","description":"ID of the agent, team, or bot"},"assignee_type":{"type":"string","description":"\"agent\", \"team\", or \"bot\""},"channel":{"type":"number","description":"ID of your channel"},"filter_id":{"type":"number","description":"ID of your saved filter"},"page_size":{"type":"number","description":"batch size"},"start_from":{"type":"number","description":"pagination start (optional)"},"state":{"type":"string","description":"\"open\", \"snooze\", \"close\", \"spam\" (defaults to \"open\")"}}},"example":{"type":"chat","assignee_id":1,"assignee_type":"agent","channel":1,"filter_id":1,"page_size":1,"start_from":1,"state":"open"}}}}}},"/api/v5/hello/v2/mail-channel":{"delete":{"tags":["Hello"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/close-all-ticket","api_endpoint":"https://control.msg91.com/api/v5/hello/v2/mail-channel"},"summary":"Close All Ticket","description":"Close All Ticket. Same endpoint also sends: Close All Ticket by Filter ID, State Change API (variant payload fields - see docs).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"assignees":{"type":"object","description":"Filters tickets by assignment status","properties":{"agents":{"type":"array","description":"Agents"},"all":{"type":"boolean","description":"All","enum":[true,false]},"bot":{"type":"boolean","description":"Bot","enum":[true,false]},"teams":{"type":"array","description":"Teams"},"unassigned":{"type":"boolean","description":"Unassigned","enum":[true,false]}}},"close_all":{"type":"boolean","description":"Must be true","enum":[true,false]},"inboxes":{"type":"array","description":"List of inbox IDs to filter, Must be non-empty","items":{"type":"number"}},"last_modified_between":{"type":"object","description":"Filters tickets by modification date range","properties":{"from_date":{"type":"string","description":"(timestamp or null): Start date"},"to_date":{"type":"string","description":"(timestamp or null): End date"}}},"last_reply_by":{"type":"array","description":"\"agent\", \"client\", \"workflow\", \"bot\"","items":{"type":"string"}},"new_state":{"type":"string","description":"Must be \"close\""}}},"example":{"assignees":{},"close_all":"","inboxes":[],"last_modified_between":{},"last_reply_by":[],"new_state":"close"}}}}},"get":{"tags":["Hello"],"parameters":[{"name":"type","in":"query","description":"Ticket state filter: Open, close, snooze, spam","required":true,"schema":{"type":"string","example":""}},{"name":"inbox_id","in":"query","description":"MSG91 Inbox Id","required":true,"schema":{"type":"string","example":""}},{"name":"page_size","in":"query","description":"Page size (0-100, default: 30)","required":true,"schema":{"type":"string","example":""}},{"name":"start_from","in":"query","description":"Pagination offset (0-100, default: 0)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/mail-ticket-list","api_endpoint":"https://control.msg91.com/api/v5/hello/v2/mail-channel"},"summary":"Mail Ticket List","description":"Mail Ticket List.","security":[{"bearerAuth":[]}]}},"/api/v5/hello/v2/inbox/all":{"get":{"tags":["Hello"],"parameters":[{"name":"inbox_list","in":"query","description":"Array of email inbox objects","required":true,"schema":{"type":"string","example":""}},{"name":"page_size","in":"query","description":"Number of records per page (default 30)","required":true,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Filter inboxes by name","required":true,"schema":{"type":"string","example":""}},{"name":"show_disabled","in":"query","description":"Include disabled/deleted inboxes (true/false, default false)","required":true,"schema":{"type":"string","example":""}},{"name":"start_from","in":"query","description":"Pagination offset (default 0)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/email-inbox-list-1","api_endpoint":"https://control.msg91.com/api/v5/hello/v2/inbox/all"},"summary":"Email Inbox List","description":"Email Inbox List.","security":[{"bearerAuth":[]}]}},"/api/v5/hello/inboxes/{inbox_id}/participants":{"get":{"tags":["Hello"],"parameters":[{"name":"inbox_id","in":"path","description":"Inbox Id","required":true,"schema":{"type":"string","example":""}},{"name":"filter_by","in":"query","description":"Filter by participant type: agent or team","required":true,"schema":{"type":"string","example":""}},{"name":"itemsPerPage","in":"query","description":"Number of records to return per page","required":true,"schema":{"type":"string","example":""}},{"name":"pageNumber","in":"query","description":"The page number to retrive","required":true,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Alphanumeric search on participants name","required":true,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"Sor participants by name: asc or desc","required":true,"schema":{"type":"string","example":""}},{"name":"status","in":"query","description":"Filter by status permitted, not permitted or all","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/get-agent-team-bot-","api_endpoint":"https://control.msg91.com/api/v5/hello/inboxes/{inbox_id}/participants"},"summary":"Agent Bot List API","description":"Agent Bot List API.","security":[{"bearerAuth":[]}]}},"/api/v5/hello/v2/mail-channel/{id}":{"put":{"tags":["Hello"],"parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/open-ticket","api_endpoint":"https://control.msg91.com/api/v5/hello/v2/mail-channel/{id}"},"summary":"Open Ticket","description":"Open Ticket.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"is_closed":{"type":"boolean","description":"false=reopen the ticket, true=close the ticket","enum":[true,false]}}},"example":{"is_closed":""}}}}}},"/api/v5/hello/saved-filter":{"get":{"tags":["Hello"],"parameters":[{"name":"agent_id","in":"query","description":"Agent Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/saved-filter-list","api_endpoint":"https://control.msg91.com/api/v5/hello/saved-filter"},"summary":"Get Saved Filter List by Agent ID","description":"Get Saved Filter List by Agent ID.","security":[{"bearerAuth":[]}]}},"/api/v5/hello/saved-filter/fitlerId":{"get":{"tags":["Hello"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/get-save-filter-list-by-filter-id","api_endpoint":"https://control.msg91.com/api/v5/hello/saved-filter/fitlerId"},"summary":"Get Save Filter list by Filter ID","description":"Get Save Filter list by Filter ID.","security":[{"bearerAuth":[]}]}},"/api/v5/hello/v2/draft/{origin}/{chat_id}":{"get":{"tags":["Hello"],"parameters":[{"name":"chat_id","in":"path","description":"Chat Id","required":true,"schema":{"type":"string","example":""}},{"name":"origin","in":"path","description":"Origin","required":true,"schema":{"type":"string","example":""}},{"name":"agent_id","in":"query","description":"Agent Id of MSG91 user","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/get-draft","api_endpoint":"https://control.msg91.com/api/v5/hello/v2/draft/{origin}/{chat_id}"},"summary":"Get Draft","description":"Get Draft.","security":[{"bearerAuth":[]}]}},"/api/v5/hello//draft/whatsapp/{chat_Id}":{"post":{"tags":["Hello"],"parameters":[{"name":"chat_Id","in":"path","description":"Chat Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/create-update-","api_endpoint":"https://control.msg91.com/api/v5/hello//draft/whatsapp/{chat_Id}"},"summary":"Create Draft/Whatsapp","description":"Create Draft/Whatsapp.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"agent_id":{"type":"number","description":"Agent id of MSG91 user"},"content":{"type":"object","description":"Contains message content","properties":{"text":{"type":"string","description":"Contains message content"},"attachment":{"type":"array","description":"Each object must have: path, name, mime_type, extension"}}},"message_type":{"type":"string","description":"Type of message being drafted: \"text\", \"text-attachment\", \"attachment\""}}},"example":{"agent_id":1,"content":{},"message_type":"string"}}}}}},"/api/v5/hello/draft/mail/{chat_id}":{"post":{"tags":["Hello"],"parameters":[{"name":"chat_id","in":"path","description":"Chat Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/create-draft-email","api_endpoint":"https://control.msg91.com/api/v5/hello/draft/mail/{chat_id}"},"summary":"Create Draft/Email","description":"Create Draft/Email.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"agent_id":{"type":"number","description":"Agent id of MSG91 user"},"content":{"type":"object","description":"Content","properties":{"attachment":{"type":"array","description":"Each URL must be HTTPS, Max URL length: 2048 characters"},"formValue":{"type":"object","description":"Form Value"},"mentioned_agent_id":{"type":"array","description":"Agent id of MSG91 user"},"message_id":{"type":"number","description":"Message ID from mail thread"},"subject":{"type":"string","description":"Email subject line"}}},"message_type":{"type":"string","description":"Type of message being drafted: \"text\", \"text-attachment\", \"attachment\""}}},"example":{"agent_id":1,"content":{},"message_type":"string"}}}}}},"/api/v5/hello/draft/whatsapp/{chat_id}/{draft_id}":{"put":{"tags":["Hello"],"parameters":[{"name":"chat_id","in":"path","description":"Chat Id","required":true,"schema":{"type":"string","example":""}},{"name":"draft_id","in":"path","description":"Draft Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/update-draft-whatsapp","api_endpoint":"https://control.msg91.com/api/v5/hello/draft/whatsapp/{chat_id}/{draft_id}"},"summary":"Update Draft/Whatsapp","description":"Update Draft/Whatsapp.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"agent_id":{"type":"number","description":"Agent id of MSG91 user"},"content":{"type":"object","description":"Contains message content","properties":{"text":{"type":"string","description":"Required for: \"text\" and \"text-attachment\" types, Max length: 500KB (500,000 characters)"},"attachment":{"type":"array","description":"Each object must have: path, name, mime_type, extension, Max: 20 attachments"}}},"message_type":{"type":"string","description":"Type of message being drafted: \"text\", \"text-attachment\", \"attachment\""}}},"example":{"agent_id":1,"content":{},"message_type":"string"}}}}}},"/api/v5/hello/draft/mail/{chat_id}/{draft_id}":{"put":{"tags":["Hello"],"parameters":[{"name":"chat_id","in":"path","description":"Chat Id","required":true,"schema":{"type":"string","example":""}},{"name":"draft_id","in":"path","description":"Draft Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/update-draft-email","api_endpoint":"https://control.msg91.com/api/v5/hello/draft/mail/{chat_id}/{draft_id}"},"summary":"Update Draft/Email","description":"Update Draft/Email.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"agent_id":{"type":"number","description":"Agent id of MSG91 user"},"content":{"type":"object","description":"Content","properties":{"attachment":{"type":"array","description":"Attachment Details"},"formValue":{"type":"object","description":"Form Value"},"mentioned_agent_id":{"type":"array","description":"Agent id of MSG91 user"},"message_id":{"type":"number","description":"Message ID from mail thread"},"subject":{"type":"string","description":"Email subject line"}}},"message_type":{"type":"string","description":"Must be: \"text-attachment"}}},"example":{"agent_id":1,"content":{},"message_type":"string"}}}}}},"/api/v5/hello/whatsapp/{chat_id}/{draft_id}":{"delete":{"tags":["Hello"],"parameters":[{"name":"chat_id","in":"path","description":"Chat Id","required":true,"schema":{"type":"string","example":""}},{"name":"draft_id","in":"path","description":"Draft Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/delete-draft","api_endpoint":"https://control.msg91.com/api/v5/hello/whatsapp/{chat_id}/{draft_id}"},"summary":"Delete Draft /Whatsapp","description":"Delete Draft /Whatsapp.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v5/hello/mail/{chat_id}/{draft_id}":{"delete":{"tags":["Hello"],"parameters":[{"name":"chat_id","in":"path","description":"Chat Id","required":true,"schema":{"type":"string","example":""}},{"name":"draft_id","in":"path","description":"Draft Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/delete-draft-email","api_endpoint":"https://control.msg91.com/api/v5/hello/mail/{chat_id}/{draft_id}"},"summary":"Delete Draft/Email","description":"Delete Draft/Email.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/v5/hello/tickets/tickets":{"get":{"tags":["Hello"],"parameters":[{"name":"type","in":"query","description":"Required, must be valid ticket state","required":true,"schema":{"type":"string","example":""}},{"name":"Page_size","in":"query","description":"Must be integer between 0-100","required":false,"schema":{"type":"string","example":""}},{"name":"Start_from","in":"query","description":"Must be integer between 0-100","required":false,"schema":{"type":"string","example":""}},{"name":"chat_inboxes","in":"query","description":"Max 100 IDs, all must be integers","required":true,"schema":{"type":"string","example":""}},{"name":"mail_inboxes","in":"query","description":"Max 100 IDs, all must be integers","required":true,"schema":{"type":"string","example":""}},{"name":"queue","in":"query","description":"(string): Search content (max 320 characters) - searches customer name, email, phone, ticket ID, subject","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/get-tickets","api_endpoint":"https://control.msg91.com/api/v5/hello/tickets/tickets"},"summary":"Get Tickets","description":"Get Tickets.","security":[{"bearerAuth":[]}]}},"/api/v5/report/analytics/bot":{"get":{"tags":["Hello"],"parameters":[{"name":"endDate","in":"query","description":"Maximum duration supported - Last 31 days. Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Supported format YYYY-MM-DD","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/hello/bot-analytics","api_endpoint":"https://control.msg91.com/api/v5/report/analytics/bot"},"summary":"Bot Analytics","description":"Bot Analytics.","security":[{"bearerAuth":[]}]}},"/api/add_client.php":{"get":{"tags":["Subaccount"],"parameters":[{"name":"services[]","in":"query","description":"1-SMS,2-Email,3-Voice,4-WhatsAPP,5-RCS","required":true,"schema":{"type":"string","example":""}},{"name":"user_company_name","in":"query","description":"User Company Name","required":true,"schema":{"type":"string","example":""}},{"name":"user_email","in":"query","description":"User Email","required":true,"schema":{"type":"string","example":""}},{"name":"user_full_name","in":"query","description":"User Full Name","required":true,"schema":{"type":"string","example":""}},{"name":"user_industry","in":"query","description":"User Industry","required":true,"schema":{"type":"string","example":""}},{"name":"user_mobile_number","in":"query","description":"User Mobile Number","required":true,"schema":{"type":"string","example":""}},{"name":"user_name","in":"query","description":"User Name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/subaccount-1/add-client-1","api_endpoint":"https://control.msg91.com/api/add_client.php"},"summary":"Add Client","description":"Add Client.","security":[{"bearerAuth":[]}]}},"/api/v5/oneapi/api/flow/{oneapi_slug}/run":{"post":{"tags":["OneAPI"],"parameters":[{"name":"oneapi_slug","in":"path","description":"Oneapi Slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.msg91.com/oneapi-1/oneapi","api_endpoint":"https://control.msg91.com/api/v5/oneapi/api/flow/{oneapi_slug}/run"},"summary":"OneAPI","description":"OneAPI.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"string","description":"Data"}}},"example":{"data":"string"}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}