Help
RSS
API
Feed
Maltego
Contact
Domain > docs.amio.io
×
More information on this domain is in
AlienVault OTX
Is this malicious?
Yes
No
DNS Resolutions
Date
IP Address
2018-10-18
34.226.151.187
(
ClassC
)
2026-02-19
104.16.242.118
(
ClassC
)
Port 80
HTTP/1.1 301 Moved PermanentlyDate: Thu, 19 Feb 2026 05:52:46 GMTContent-Type: text/htmlContent-Length: 167Connection: keep-aliveCache-Control: max-age3600Expires: Thu, 19 Feb 2026 06:52:46 GMTLocation: https://docs.amio.io/Server: cloudflareCF-RAY: 9d038003db9168f1-PDXalt-svc: h3:443; ma86400 html>head>title>301 Moved Permanently/title>/head>body>center>h1>301 Moved Permanently/h1>/center>hr>center>cloudflare/center>/body>/html>
Port 443
HTTP/1.1 200 OKDate: Thu, 19 Feb 2026 05:52:46 GMTContent-Type: text/html; charsetutf-8Transfer-Encoding: chunkedConnection: keep-aliveCF-RAY: 9d0380043cec613d-PDXCache-Control: s-maxage900, stale-if-error900content-language: enrndr-id: b4b989da-ad91-433estrict-transport-security: max-age31536000vary: Accept-Encodingx-content-type-options: nosniffx-dns-prefetch-control: offx-download-options: noopenx-frame-options: Denyx-ratelimit-limit: 100x-ratelimit-remaining: 99x-ratelimit-reset: 1771480174x-render-origin-server: Renderx-xss-protection: 1; modeblockCF-Cache-Status: HITServer: cloudflarealt-svc: h3:443; ma86400 !DOCTYPE html>html langen style data-color-modelight class useReactApp >head>meta charsetutf-8>meta namereadme-deploy content5.612.0>meta namereadme-subdomain contentamio>meta namereadme-version content1.0>title>Amio/title>meta namedescription data-rhtrue>meta propertyog:title contentAmio data-rhtrue>meta propertyog:description data-rhtrue>meta propertyog:site_name contentAmio>meta nametwitter:title contentAmio data-rhtrue>meta nametwitter:description data-rhtrue>meta nametwitter:card contentsummary_large_image>meta nameviewport contentwidthdevice-width, initial-scale1.0>meta propertyog:image contenthttps://cdn.readme.io/og-image/create?typehome&titleAmio&projectTitleAmio&descriptionAmio%20REST%20API%20reference%20documentation.%20The%20API%20allows%20you%20to%20send%20messages%20to%20users%20on%20various%20messaging%20platforms%20as%20well%20as%20receive%20them%20back%20via%20webhooks%20invocations.%20Amio%20REST%20API%20follows%20proven%20design%20principle%20to%20make%20it%20really%20easy%20for%20you%20to%20start%20with%20messaging%20today.&logoUrlhttps%3A%2F%2Ffiles.readme.io%2Fd30580e-small-doclogo.png&color%23664ac5&variantlight data-rhtrue>meta nametwitter:image contenthttps://cdn.readme.io/og-image/create?typehome&titleAmio&projectTitleAmio&descriptionAmio%20REST%20API%20reference%20documentation.%20The%20API%20allows%20you%20to%20send%20messages%20to%20users%20on%20various%20messaging%20platforms%20as%20well%20as%20receive%20them%20back%20via%20webhooks%20invocations.%20Amio%20REST%20API%20follows%20proven%20design%20principle%20to%20make%20it%20really%20easy%20for%20you%20to%20start%20with%20messaging%20today.&logoUrlhttps%3A%2F%2Ffiles.readme.io%2Fd30580e-small-doclogo.png&color%23664ac5&variantlight data-rhtrue>meta propertyog:image:width content1200>meta propertyog:image:height content630>link idfavicon relshortcut icon hrefhttps://files.readme.io/dc20ed1-small-favicon-32x32.png typeimage/png>link relcanonical hrefhttps://docs.amio.io/>script srchttps://cdn.readme.io/public/js/unauthorized-redirect.js?1771448710533>/script>script srchttps://cdn.readme.io/public/js/cash-dom.min.js?1771448710533>/script>link data-chunkFooter relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css>link data-chunkroutes-Landing relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css>link data-chunkindex relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/index.8ca2c2c4702dddc43f78.css>link data-chunkRDMD relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/RDMD.9331f322bb5b573f9d25.css>link data-chunkRDMD relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/7752.3285ba3fb2d992038206.css>link data-chunkHeader relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/Header.788692f13632f26bdba9.css>link data-chunkmain relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/main.32162abeabcd2e858294.css>link data-chunkmain relpreload asstyle hrefhttps://cdn.readme.io/public/hub/web/ui-styles.aabd327c6e0a532e2213.css>link data-chunkmain relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/main.806058b4f4e888a778d0.js>link data-chunkroutes-SuperHub relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/routes-SuperHub.56f6c06b0330648b0a5a.js>link data-chunkHeader relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/Header.fb8b328025fcf3d323a8.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/3766.b6d2e3abde0d888cc685.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/6563.17a0dc96c8f90ede2986.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/6123.49a3637ce0366b21ac76.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/5026.d45551fe6a0c387bfbf3.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/6146.cb8f37a2ef0ab72d4bf7.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/1617.8b58072ca1f43ebe9335.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/1402.3d5f34dc903e8d858221.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/8850.d1e8a4322360350858ab.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/6825.a2791b642c85615e3e48.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/7752.c90354ae98c32b8ff740.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/4986.8c84c96194bf13b046d6.js>link data-chunkRDMD relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/RDMD.7113824b8cf2c57765a3.js>link data-chunkindex relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/6306.5e9980ce77e94d962e78.js>link data-chunkindex relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/6083.37273c905f7c86da051d.js>link data-chunkindex relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/index.f4457e32e66038d1fd03.js>link data-chunkroutes-Landing relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/routes-Landing.a45af69b7b4425698483.js>link data-chunkFooter relpreload asscript hrefhttps://cdn.readme.io/public/hub/web/Footer.1b7490d3d8625b3ad4c4.js>link data-chunkmain relstylesheet hrefhttps://cdn.readme.io/public/hub/web/ui-styles.aabd327c6e0a532e2213.css>link data-chunkmain relstylesheet hrefhttps://cdn.readme.io/public/hub/web/main.32162abeabcd2e858294.css>link data-chunkHeader relstylesheet hrefhttps://cdn.readme.io/public/hub/web/Header.788692f13632f26bdba9.css>link data-chunkRDMD relstylesheet hrefhttps://cdn.readme.io/public/hub/web/7752.3285ba3fb2d992038206.css>link data-chunkRDMD relstylesheet hrefhttps://cdn.readme.io/public/hub/web/RDMD.9331f322bb5b573f9d25.css>link data-chunkindex relstylesheet hrefhttps://cdn.readme.io/public/hub/web/index.8ca2c2c4702dddc43f78.css>link data-chunkroutes-Landing relstylesheet hrefhttps://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css>link data-chunkFooter relstylesheet hrefhttps://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css>!-- CUSTOM CSS-->style titlerm-custom-css>:root{--project-color-primary:#664ac5;--project-color-inverse:#fff;--recipe-button-color:#7238ff;--recipe-button-color-hover:#3d00d1;--recipe-button-color-active:#2e009e;--recipe-button-color-focus:rgba(114, 56, 255, 0.25);--recipe-button-color-disabled:#ffffff}identerprise .ReadMeUIisAlgoliaSearch{--project-color-primary:#664ac5;--project-color-inverse:#fff}a{color:var(--color-link-primary,#7238ff)}a:hover{color:var(--color-link-primary-darken-5,#3d00d1)}a.text-muted:hover{color:var(--color-link-primary,#7238ff)}.btn.btn-primary{background-color:#7238ff}.btn.btn-primary:hover{background-color:#3d00d1}.theme-line #hub-landing-top h2{color:#7238ff}#hub-landing-top .btn:hover{color:#7238ff}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#664ac5}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#664ac5,#5f4df7)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(https://files.readme.io/db60208-docbg.jpg)}.theme-line header#hub-header #header-top{border-bottom-color:#664ac5}.theme-line header#hub-header #header-top .btn{background-color:#664ac5}header#hub-header #header-top #header-logo{width:116px;height:40px;margin-top:0;background-image:url(https://files.readme.io/2f818fb-white-logo.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#664ac5}#subheader-links a.active{color:#664ac5!important;box-shadow:inset 0 -2px 0 #664ac5}#subheader-links a:hover{color:#664ac5!important;box-shadow:inset 0 -2px 0 #664ac5;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#7238ff}section#hub-discuss .discussion a .discuss-body h4{color:#7238ff}section#hub-discuss .discussion a:hover .discuss-body h4{color:#3d00d1}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#7238ff}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#7238ff}#hub-search-results h3 em{color:#7238ff}.main_background,.tag-item{background:#7238ff!important}.main_background:hover{background:#3d00d1!important}.main_color{color:#664ac5!important}.border_bottom_main_color{border-bottom:2px solid #664ac5}.main_color_hover:hover{color:#664ac5!important}section#hub-discuss h1{color:#7238ff}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#7238ff;background-color:#7238ff}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#3d00d1;border-color:#3d00d1}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#7238ff;color:#7238ff}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#7238ff);border-color:var(--project-color-primary,#7238ff)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#3d00d1;border-color:#3d00d1}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#7238ff;fill:var(--project-color-primary,#7238ff)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#7238ff}.main-color-accent{border-bottom:3px solid #664ac5;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES */.content-body .magic-block-api-header ol li,.content-body .magic-block-api-header ul li,.content-body .magic-block-textarea ol li,.content-body .magic-block-textarea ul li{margin-bottom:.15em}/*! END HUB_CUSTOM_STYLES */.useReactApp div h3 a .pull-right{color:#bbb;font-weight:400;font-size:12px;text-transform:uppercase;padding-top:6px}.useReactApp .field-description strong{font-weight:700;padding:10px;font-size:20px}.useReactApp .col-sm-4{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%;padding:10px!important}@media only screen and (min-width:48em){.useReactApp .col-sm-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%;padding:20px!important}.useReactApp .row.hub-landing-links.left{display:flex}}.useReactApp .rm-Logo-img{width:116px;height:40px}/style>meta nameloadedProject contentamio>script>var storedColorMode `light` system ? window.localStorage.getItem(color-scheme) : `light`document.querySelector(data-color-mode).setAttribute(data-color-mode, storedColorMode)/script>script idconfig typeapplication/json data-json{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"api":{"upload":{"fileSizeLimit":10485760,"fileSizeLimitFormatted":"10MB"}},"asset_url":"https://cdn.readme.io","dashDomain":"dash.readme.com","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"git":{"sync":{"bitbucket":{"installationLink":"https://developer.atlassian.com/console/install/310151e6-ca1a-4a44-9af6-1b523fea0561?signatureAYABeMn9vqFkrg%2F1DrJAQxSyVf4AAAADAAdhd3Mta21zAEthcm46YXdzOmttczp1cy13ZXN0LTI6NzA5NTg3ODM1MjQzOmtleS83MDVlZDY3MC1mNTdjLTQxYjUtOWY5Yi1lM2YyZGNjMTQ2ZTcAuAECAQB4IOp8r3eKNYw8z2v%2FEq3%2FfvrZguoGsXpNSaDveR%2FF%2Fo0BHUxIjSWx71zNK2RycuMYSgAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDOJgARbqndU9YM%2FRdQIBEIA7unpCah%2BIu53NA72LkkCDhNHOv%2BgRD7agXAO3jXqw0%2FAcBOB0%2F5LmpzB5f6B1HpkmsAN2i2SbsFL30nkAB2F3cy1rbXMAS2Fybjphd3M6a21zOmV1LXdlc3QtMTo3MDk1ODc4MzUyNDM6a2V5LzQ2MzBjZTZiLTAwYzMtNGRlMi04NzdiLTYyN2UyMDYwZTVjYwC4AQICAHijmwVTMt6Oj3F%2B0%2B0cVrojrS8yZ9ktpdfDxqPMSIkvHAGT%2FMTvCxC3XwnwlulZe975AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMMUUe9d1YmFOo373TAgEQgDuJo7TayM6NL19Sj9RPooRrl8rYxwKgvu9gkLNc3GuyyovWI1xA2qTr0LQzMRsf3imrAWsywzPcsjnvuAAHYXdzLWttcwBLYXJuOmF3czprbXM6dXMtZWFzdC0xOjcwOTU4NzgzNTI0MzprZXkvNmMxMjBiYTAtNGNkNS00OTg1LWI4MmUtNDBhMDQ5NTJjYzU3ALgBAgIAeLKa7Dfn9BgbXaQmJGrkKztjV4vrreTkqr7wGwhqIYs5AZR28Sibv2eBxSIg2MydtvEAAAB%2BMHwGCSqGSIb3DQEHBqBvMG0CAQAwaAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzzWhThsIgJwrr%2FY2ECARCAOxoaW9pob21lweyAfrIm6Fw7gd8D%2B%2F8LHk4rl3jjULDM35%2FVPuqBrqKunYZSVCCGNGB3RqpQJr%2FasASiAgAAAAAMAAAQAAAAAAAAAAAAAAAAAEokowLKsF1tMABEq%2BKNyJP%2F%2F%2F%2F%2FAAAAAQAAAAAAAAAAAAAAAQAAADJLzRcp6MkqKR43PUjOiRxxbxXYhLc6vFXEutK3%2BQ71yuPq4dC8pAHruOVQpvVcUSe8dptV8c7wR8BTJjv%2F%2FNe8r0g%3D&productbitbucket"}}},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"micro":{"baseUrl":"https://micro-beta.readme.com"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.612.0","reservedWords":{"tools":"execute-request","get-code-snippet","get-endpoint","get-request-body","get-response-schema","get-server-variables","list-endpoints","list-security-schemes","list-specs","search-specs","search","fetch"},"sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}>/script>/head>body classbody-none theme-solid header-gradient header-bg-size-cover header-bg-pos-cc header-overlay-grain reference-layout-row lumosity-normal no-sidebar hub-is-home>div idssr-top>/div>div idssr-main>div classApp ThemeContext ThemeContext_dark ThemeContext_classic style--color-primary:#664ac5;--color-primary-inverse:#fff;--color-primary-alt:#5f4df7;--color-primary-darken-10:#4f35a7;--color-primary-darken-20:#3d2980;--color-primary-alpha-25:rgba(102, 74, 197, 0.25);--color-link-primary:#7238ff;--color-link-primary-darken-5:#601eff;--color-link-primary-darken-10:#4e05ff;--color-link-primary-darken-20:#3d00d1;--color-link-primary-alpha-50:rgba(114, 56, 255, 0.5);--color-link-primary-alpha-25:rgba(114, 56, 255, 0.25);--color-link-background:rgba(114, 56, 255, 0.09);--color-link-text:#fff;--color-tab-active:#664ac5;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)>div classContentWithOwlbotx4PaFDoA1KMz>div classContentWithOwlbot-content2X1XexaN8Lf2>header classHeader3zzata9F_ZPQ rm-Header_classic rm-Header rm-Header_gradient>div classrm-Header-top Header-topuTMpygDG4e1V Header-top_classic3g7Q6zoBy8zh>div classrm-Container rm-Container_flex>div styleoutline:none tabindex-1>a href#content target_self classButton Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary>Jump to Content/a>/div>div classrm-Header-left Header-leftADQdGVqx1wqU>a classrm-Logo Header-logo1Xy41PtkzbdG hrefhttps://amio.io target_self>img altAmio classrm-Logo-img Header-logo-img3YvV4lcGKkeb srchttps://files.readme.io/2f818fb-white-logo.png/>/a>/div>div classrm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF>div>button aria-labelToggle navigation menu classicon-menu menu3d6DYNDa3tk5 typebutton>/button>div class>div classFlyout95xhYIIoTKtc undefined rm-Flyout data-testidflyout>div classMobileFlyout1hHJpUd-nYkd>a aria-currentpage classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active href/ target_self>i classicon-landing-page-2 NavItem-badge1qOxpfTiALoz rm-Header-bottom-link-icon>/i>span classNavItem-textSlZuuL489uiw>Home/span>/a>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- href/docs target_self>i classicon-guides NavItem-badge1qOxpfTiALoz rm-Header-bottom-link-icon>/i>span classNavItem-textSlZuuL489uiw>Documentation/span>/a>a classrm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- href/reference target_self>i classicon-references NavItem-badge1qOxpfTiALoz rm-Header-bottom-link-icon>/i>span classNavItem-textSlZuuL489uiw>API Reference/span>/a>hr classMobileFlyout-divider10xf7R2X1MeW/>a classMobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo hrefhttps://amio.io target_self>img altAmio classHeader-logo-img3YvV4lcGKkeb rm-Logo-img srchttps://files.readme.io/2f818fb-white-logo.png/>/a>/div>/div>/div>/div>div classHeader-left-nav2xWPWMNHOGf_>i aria-hiddentrue classicon-landing-page-2 Header-left-nav-icon10glJKFwewOv>/i>Home/div>/div>div classrm-Header-right Header-right21PC2XTT6aMg>span classHeader-right_desktop14ja01RUQ7HE>/span>div classHeader-searchtb6Foi0-D9Vx>button aria-labelSearch ⌘k classrm-SearchToggle data-symbol⌘>div classrm-SearchToggle-icon icon-search1>/div>/button>/div>/div>/div>div classcontainer>section classLandingPageHeader20SNhBZ58Jy5 rm-LandingPageHeader>h1 classLandingPageHeader-title16RMwPkp2O2W>Amio Developer Hub/h1>div classrm-Markdown markdown-body LandingPageHeader-text3zJOEVqnHdlf data-testidRDMD>p>Welcome to Amio! Let's build on top of most reliable and full feature set API for messaging./p>/div>div aligncenter classFlex Flex_row justifystart style--flex-gap:var(--md)>a classButton Button_md LandingPageHeader-button_primaryLpo1zn3KXh20 href/docs target_self>i classicon-guides>/i>span>Get Started/span>/a>/div>/section>/div>/div>div classHeader-bottom2eLKOFXMEmh5 Header-bottom_classic rm-Header-bottom>div classrm-Container rm-Container_flex>nav aria-labelPrimary navigation classHeader-leftADQdGVqx1wqU Header-subnavnVH8URdkgvEl rolenavigation>div classrm-NavLinksDropdown Dropdown Dropdown_closed data-testiddropdown-container>div classDropdown-toggle aria-haspopupdialog>button classrm-Header-link rm-Header-bottom-link NavItem2xSfFaVqfRjy Button Button_slate_text Button_md typebutton>span>Home/span>i classNavItem-chevron3ZtU4bd1q5sy icon-chevron-down>/i>/button>/div>/div>/nav>/div>/div>div classhub-search-results--reactApp idhub-search-results>div classhub-container>div classmodal-backdrop rm-SearchModal rolebutton tabindex0>/div>/div>/div>/header>main classLandingWrap16kRMSdr5J8g rm-LandingPage idcontent>div classrm-Markdown markdown-body LandingBlock3PM-HyBxby3X LandingBlock_alignleftG1r7ROyW_AGB data-testidRDMD>div classrdmd-html>div classrow hub-landing-links left stylepadding: 30px> div classcol-sm-4 col-xs-12 stylepadding: 0 20px> h3 classmain_color>a href/docs ui-srefdocs> div classpull-right>View All/div> i classicon icon-documentation>/i>strong classmain_color>Documentation/strong>/a>/h3> ul classlinks> li styletext-align: center; padding: 10px 20px;> Guides and comprehensive instructions which help you start with all types of messaging platforms in short time. /li> /ul> /div> div classcol-sm-4 col-xs-12 stylepadding: 0 20px> h3 classmain_color>a href/reference ui-srefreference> div classpull-right>View All/div> i classicon icon-reference>/i>strong classmain_color>API Reference/strong>/a>/h3> ul classlinks> li styletext-align: center; padding: 10px 20px;> Complete REST API reference documentation with code examples and messenger screenshots. /li> /ul> /div> div classcol-sm-4 col-xs-12 stylepadding: 0 20px> h3> a href/cdn-cgi/l/email-protection#ea999f9a9a85989eaa8b878385c48385> div classpull-right>Contact Us/div> i classicon icon-support>/i>strong classmain_color>Support/strong>/a>/h3> ul classlinks> li styletext-align: center; padding: 10px 20px;> We truly care about our customers. So if you cant find something in Amio documentation or you have any questions or comments, contact us on a href/cdn-cgi/l/email-protection#72010702021d000632131f1b1d5c1b1d>span class__cf_email__ data-cfemail81f2f4f1f1eef3f5c1e0ece8eeafe8ee>email protected/span>/a>. /li> /ul> /div>/div>/div>/div>/main>footer aria-labelStatus banner classFooter2U8XAPoGhlgO AppFooter rm-Banners>/footer>div classModalWrapper idChatGPT-modal>/div>/div>/div>/div>/div>div classng-non-bindable>script data-cfasyncfalse src/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js>/script>script idssr-props typeapplication/json>{sidebars:{docs:{_id:59fc42803cf718001069b92c,title:Introduction,createdAt:2017-05-11T08:09:08.020Z,from_sync:false,project:584bd29609104d23007d9ec9,order:0,reference:false,slug:test,version:59fc42803cf718001069b9ab,__v:0,isAPI:false,pages:{_id:59fc42803cf718001069b97d,parentDoc:null,sync_unique:,createdAt:2017-05-11T08:41:25.049Z,isReference:false,link_external:false,link_url:,title:Introduction,api:{params:,url:,method:get,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},auth:required},hidden:false,order:0,slug:amio-introduction,category:59fc42803cf718001069b92c,type:basic,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b99b,link_external:false,link_url:,category:59fc42803cf718001069b92c,isReference:false,type:basic,slug:getting-started,hidden:false,parentDoc:null,sync_unique:,api:{url:,method:get,results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:},order:1,title:Getting Started,createdAt:2017-05-30T08:43:04.631Z,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b97e,category:59fc42803cf718001069b92c,link_external:false,order:2,title:Channels,hidden:false,sync_unique:,type:basic,api:{auth:required,params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}}},parentDoc:null,slug:messaging-channels,createdAt:2017-05-11T08:59:44.010Z,isReference:false,link_url:,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b99a,parentDoc:null,hidden:false,link_url:,type:basic,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},order:3,slug:tooling,title:Tooling,createdAt:2017-05-25T17:04:52.908Z,isReference:false,link_external:false,category:59fc42803cf718001069b92c,sync_unique:,isBodyEmpty:false,children:{_id:5bdc409a6c0270004a84f609,category:59fc42803cf718001069b92c,parentDoc:59fc42803cf718001069b99a,createdAt:2018-11-02T12:18:34.806Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:postman,type:basic,title:Postman,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5bdad59a7ff77e001f39f0cc,category:59fc42803cf718001069b92c,parentDoc:59fc42803cf718001069b99a,createdAt:2018-11-01T10:29:46.060Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:ngrok,type:basic,title:Ngrok,isBodyEmpty:false,children:}},{_id:5b6ac8e8e7c35b0003e31e65,category:59fc42803cf718001069b92c,createdAt:2018-08-08T10:41:44.818Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:4,slug:miscellaneous,type:basic,title:Miscellaneous,parentDoc:null,isBodyEmpty:false,children:},{_id:62ff4289d45ed10091ecdb33,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:From first example to fully automated chat,icon:,type:basic,slug:first-intent,order:5,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-08-19T07:58:01.654Z,category:59fc42803cf718001069b92c,parentDoc:null,isBodyEmpty:false,children:{_id:6339a652abd8e10017d46e92,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Start your first conversation,icon:,type:basic,slug:start-your-first-conversation,order:0,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T14:55:14.693Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339a6f2b627c3006b99e35f,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Create and suggest intents,icon:,type:basic,slug:create-and-suggest-intents,order:1,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T14:57:54.647Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339acb98fa4d90073970b22,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Add more examples,icon:,type:basic,slug:create-answers-1,order:2,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T15:22:33.551Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339b0497fbbfd03b5920fec,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Conversation structure,icon:,type:basic,slug:conversation-structure,order:3,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T15:37:45.831Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339b1f13ccedc00a553c56b,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Conversation editor,icon:,type:basic,slug:conversation-editor,order:4,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T15:44:49.877Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,mdx:{},isBodyEmpty:false,children:},{_id:6339b48610c88f0513c96577,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Answer publishing,icon:,type:basic,slug:answer-publishing,order:5,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T15:55:50.005Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339b64acdba7a00998b99f8,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Operator status,icon:,type:basic,slug:operator-status,order:6,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T16:03:22.842Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:64edfafafaac6c00205a5812,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:Chatbot context,icon:,type:basic,slug:chatbot-context,order:7,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:59fc42803cf718001069b92c,createdAt:2023-08-29T14:04:42.375Z,parentDoc:62ff4289d45ed10091ecdb33,mdx:{},isBodyEmpty:false,children:}}},{_id:67c87f5f8987170010065a43,title:Chatbot,slug:chatbot,order:1,reference:false,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,createdAt:2025-03-05T16:44:15.390Z,__v:0,pages:{_id:67c881198987170010066814,mdx:{},api:{method:get,url:,auth:required,params:},title:🛍️ Product Feeds: Best Practices,icon:,type:basic,slug:bot-product-feeds-best-practices,order:0,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:️-product-feeds-best-practices,category:67c87f5f8987170010065a43,createdAt:2025-03-05T16:51:37.900Z,parentDoc:null,isBodyEmpty:false,children:}},{_id:5c9b9f9ba1cc170039471288,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2019-03-27T16:06:51.263Z,order:2,slug:amio-chat-1,title:Amio Chat,__v:0,pages:{_id:5c9ba291bb4936000e74a1c0,createdAt:2019-03-27T16:19:29.132Z,category:5c9b9f9ba1cc170039471288,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:amio-chat,type:basic,title:Amio Chat,parentDoc:null,isBodyEmpty:false,children:},{_id:5ef07245ec4a5d001fa2c94d,api:{method:get,url:,auth:required,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},params:},title:Getting Started: Amio Web Chat,type:basic,slug:amio-chat-getting-started-web-chat,order:1,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,createdAt:2020-06-22T08:56:37.409Z,category:5c9b9f9ba1cc170039471288,parentDoc:null,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:{_id:5ef072f3b011fa0011834f28,api:{method:get,url:,auth:required,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},params:,examples:{codes:}},title:Connect Amio Chat,type:basic,slug:amio-chat-getting-started-web-chat-connect-amio-chat,order:0,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,parentDoc:5ef07245ec4a5d001fa2c94d,createdAt:2020-06-22T08:59:31.119Z,category:5c9b9f9ba1cc170039471288,previousSlug:,deprecated:false,icon:,mdx:{},isBodyEmpty:false,children:},{_id:5ef0bd902a613d00453aff82,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Receive message through Amio API,type:basic,slug:amio-chat-getting-started-web-chat-receive-message-through-amio-api,order:1,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,createdAt:2020-06-22T14:17:52.940Z,parentDoc:5ef07245ec4a5d001fa2c94d,category:5c9b9f9ba1cc170039471288,isBodyEmpty:false,children:},{_id:5ef0bb7b28d3ac001106329a,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Send message through Amio API,type:basic,slug:amio-chat-getting-started-web-chat-send-message-through-amio-api,order:2,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,createdAt:2020-06-22T14:08:59.668Z,parentDoc:5ef07245ec4a5d001fa2c94d,category:5c9b9f9ba1cc170039471288,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:61dd8a81744b220045a60317,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:API methods,type:basic,slug:amio-chat-api-methods,order:3,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:open-and-close-methods,createdAt:2022-01-11T13:47:45.464Z,parentDoc:5ef07245ec4a5d001fa2c94d,category:5c9b9f9ba1cc170039471288,icon:,mdx:{},isBodyEmpty:false,children:{_id:67ef97ea386fc6e2ccf80fe6,mdx:{},api:{method:get,url:,auth:required,params:},title:Theme properties,icon:,type:basic,slug:theme-properties,order:0,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:61dd8a81744b220045a60317,category:5c9b9f9ba1cc170039471288,createdAt:2025-04-04T08:27:22.440Z,isBodyEmpty:false,children:},{_id:6824bf6fcf59aa0030c39e0c,mdx:{},api:{method:get,url:,auth:required,params:},title:Text properties,icon:,type:basic,slug:text-properties,order:1,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:61dd8a81744b220045a60317,category:5c9b9f9ba1cc170039471288,createdAt:2025-05-14T16:06:07.050Z,isBodyEmpty:false,children:}}},{_id:68beea2f98707f91f249cda3,title:Getting Started: Mobile App,icon:,type:basic,slug:getting-started-mobile-app,mdx:{},category:5c9b9f9ba1cc170039471288,order:2,isReference:false,deprecated:false,api:{method:get,url:,auth:required,params:},hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2025-09-08T14:37:35.778Z,parentDoc:null,isBodyEmpty:false,children:},{_id:5c9ba3373c9f770051af8ec8,createdAt:2019-03-27T16:22:15.399Z,category:5c9b9f9ba1cc170039471288,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:amio-chat-getting-started-sdk,type:basic,title:Getting Started: SDK for Web,parentDoc:null,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:{_id:5ca4639d2b3bee00632c7887,createdAt:2019-04-03T07:41:17.217Z,category:5c9b9f9ba1cc170039471288,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:amio-chat-getting-started-sdk-connect-amio-chat,type:basic,title:Connect Amio Chat,parentDoc:5c9ba3373c9f770051af8ec8,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5ca4644ca7db9e0013384003,createdAt:2019-04-03T07:44:12.171Z,category:5c9b9f9ba1cc170039471288,parentDoc:5c9ba3373c9f770051af8ec8,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:amio-chat-getting-started-sdk-send-message-from-web,type:basic,title:Send message from Web,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5ca4646fee50aa001fed64cc,createdAt:2019-04-03T07:44:47.334Z,category:5c9b9f9ba1cc170039471288,parentDoc:5c9ba3373c9f770051af8ec8,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:amio-chat-getting-started-sdk-receive-message-on-web,type:basic,title:Receive message on Web,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5ca46e4e512269005c905171,createdAt:2019-04-03T08:26:54.214Z,category:5c9b9f9ba1cc170039471288,parentDoc:5c9ba3373c9f770051af8ec8,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:amio-chat-getting-started-sdk-send-message-through-amio-api,type:basic,title:Send message through Amio API,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5ca475ecb9ca760014d6a5cd,createdAt:2019-04-03T08:59:24.553Z,category:5c9b9f9ba1cc170039471288,parentDoc:5c9ba3373c9f770051af8ec8,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:4,slug:amio-chat-getting-started-sdk-receive-message-through-amio-api,type:basic,title:Receive message through Amio API,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:63c9c1a36d0a96006af37536,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Ticket Deflection,icon:,type:basic,slug:tisket-deflection,order:4,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:deflection,parentDoc:null,category:5c9b9f9ba1cc170039471288,createdAt:2023-01-19T22:18:11.121Z,mdx:{},isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b92d,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,createdAt:2017-05-11T09:01:24.683Z,order:3,slug:facebook-messenger,__v:0,reference:false,from_sync:false,title:Facebook Messenger,pages:{_id:59fc42803cf718001069b984,title:Facebook Messenger,isReference:false,order:0,slug:facebook-messenger,api:{url:,method:get,results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:},createdAt:2017-05-12T06:48:56.526Z,parentDoc:null,type:basic,sync_unique:,hidden:false,link_external:false,link_url:,category:59fc42803cf718001069b92d,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b989,type:basic,createdAt:2017-05-12T11:28:28.721Z,parentDoc:null,hidden:false,link_external:false,link_url:,sync_unique:,title:Getting Started,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required},category:59fc42803cf718001069b92d,slug:facebook-messenger-getting-started,isReference:false,order:1,isBodyEmpty:false,children:{_id:59fc42803cf718001069b980,isReference:false,slug:facebook-messenger-getting-started-prepare-facebook-page,order:0,type:basic,hidden:false,link_external:false,link_url:,parentDoc:59fc42803cf718001069b989,category:59fc42803cf718001069b92d,createdAt:2017-05-11T09:02:38.346Z,sync_unique:,api:{results:{codes:{status:200,language:json,code:{},name:},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get},title:Prepare Facebook Page,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b990,category:59fc42803cf718001069b92d,parentDoc:59fc42803cf718001069b989,slug:facebook-messenger-getting-started-connect-facebook-page,sync_unique:,api:{method:get,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},auth:required,params:,url:},createdAt:2017-05-25T09:01:38.419Z,isReference:false,type:basic,link_external:false,link_url:,order:1,title:Connect Facebook Page,hidden:false,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b992,hidden:false,isReference:false,title:Send Message,category:59fc42803cf718001069b92d,createdAt:2017-05-25T09:19:38.366Z,order:2,type:basic,link_url:,parentDoc:59fc42803cf718001069b989,sync_unique:,api:{method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:},link_external:false,slug:facebook-messenger-getting-started-send-message,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b991,createdAt:2017-05-25T09:05:11.542Z,hidden:false,slug:facebook-messenger-getting-started-receive-message,type:basic,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required},category:59fc42803cf718001069b92d,isReference:false,link_url:,parentDoc:59fc42803cf718001069b989,sync_unique:,link_external:false,order:3,title:Receive Message,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b97f,hidden:false,parentDoc:null,api:{auth:required,params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}}},category:59fc42803cf718001069b92d,createdAt:2017-05-11T09:01:50.889Z,link_url:,title:Entry Points,order:2,type:basic,isReference:false,link_external:false,slug:facebook-messenger-entry-points,sync_unique:,isBodyEmpty:false,children:{_id:59fc42803cf718001069b996,slug:facebook-messenger-entry-points-from-facebook,type:basic,createdAt:2017-05-25T13:13:33.724Z,hidden:false,parentDoc:59fc42803cf718001069b97f,isReference:false,link_external:false,sync_unique:,api:{results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},category:59fc42803cf718001069b92d,link_url:,order:0,title:From Facebook,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b999,createdAt:2017-05-25T13:22:18.867Z,link_external:false,title:Using Phone Number,sync_unique:,api:{method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:},category:59fc42803cf718001069b92d,isReference:false,hidden:false,link_url:,type:basic,order:1,parentDoc:59fc42803cf718001069b97f,slug:facebook-messenger-entry-points-using-phone-number,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b997,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},slug:facebook-messenger-entry-points-from-webpage,sync_unique:,type:basic,isReference:false,link_url:,category:59fc42803cf718001069b92d,createdAt:2017-05-25T13:13:50.010Z,hidden:false,order:2,link_external:false,parentDoc:59fc42803cf718001069b97f,title:From Webpage,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b998,link_external:false,link_url:,parentDoc:59fc42803cf718001069b97f,createdAt:2017-05-25T13:14:57.779Z,isReference:false,order:3,sync_unique:,title:From Messenger,type:basic,api:{url:,method:get,results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:},category:59fc42803cf718001069b92d,hidden:false,slug:facebook-messenger-entry-points-from-messenger,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b99d,category:59fc42803cf718001069b92d,parentDoc:59fc42803cf718001069b97f,createdAt:2017-06-26T08:38:20.835Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:4,slug:facebook-messenger-entry-points-offline,type:basic,title:Offline,isBodyEmpty:false,children:}},{_id:5b30f66ddf0e3b0003abb71d,category:59fc42803cf718001069b92d,createdAt:2018-06-25T14:04:29.472Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:tutorials,type:basic,title:Tutorials,parentDoc:null,isBodyEmpty:false,children:{_id:59fc42803cf718001069b9a3,category:59fc42803cf718001069b92d,parentDoc:5b30f66ddf0e3b0003abb71d,createdAt:2017-08-17T07:05:51.873Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:facebook-messenger-tutorials-custom-facebook-app,type:basic,title:Custom Facebook App,isBodyEmpty:false,children:},{_id:5ba2174f4f89f700039d8ed8,category:59fc42803cf718001069b92d,parentDoc:5b30f66ddf0e3b0003abb71d,createdAt:2018-09-19T09:30:55.742Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:facebook-messenger-tutorials-subscription-messages,type:basic,title:Subscription Messages,isBodyEmpty:false,children:}},{_id:5df2013fd20ce402cd372be5,category:59fc42803cf718001069b92d,createdAt:2019-12-12T08:49:59.989Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:4,slug:facebook-messenger-policy,type:basic,title:Policy,parentDoc:null,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b931,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,from_sync:false,__v:0,project:584bd29609104d23007d9ec9,createdAt:2017-05-11T09:43:28.314Z,order:4,slug:mobile,title:Mobile (SMS),pages:{_id:59fc42803cf718001069b987,type:basic,hidden:false,slug:mobile,createdAt:2017-05-12T06:50:45.262Z,order:0,sync_unique:,category:59fc42803cf718001069b931,link_url:,parentDoc:null,title:Mobile,api:{method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:},isReference:false,link_external:false,isBodyEmpty:false,children:},{_id:5b29128d94e1f7000317fdb9,category:59fc42803cf718001069b931,createdAt:2018-06-19T14:26:21.474Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:mobile-getting-started,type:basic,title:Getting Started,parentDoc:null,isBodyEmpty:false,children:{_id:5b29133df11cd000039cae4f,category:59fc42803cf718001069b931,parentDoc:5b29128d94e1f7000317fdb9,createdAt:2018-06-19T14:29:17.081Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:mobile-messagebird,type:basic,title:MessageBird,isBodyEmpty:false,children:},{_id:5b2a343d6f58a00003e5d30c,category:59fc42803cf718001069b931,parentDoc:5b29128d94e1f7000317fdb9,createdAt:2018-06-20T11:02:21.316Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:mobile-send-message,type:basic,title:Send Message,isBodyEmpty:false,children:},{_id:5b47105b3d4a9e00037896af,category:59fc42803cf718001069b931,parentDoc:5b29128d94e1f7000317fdb9,createdAt:2018-07-12T08:24:59.858Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:mobile-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:}}},{_id:5d569fa6251176006d5c0d2b,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2019-08-16T12:20:54.310Z,order:5,slug:rcs-business-messages,title:RCS Business Messages,__v:0,pages:{_id:5d569fcbdb6b9500441edf54,createdAt:2019-08-16T12:21:31.827Z,category:5d569fa6251176006d5c0d2b,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:rbm-rcs-business-messages,type:basic,title:RCS Business Messages,parentDoc:null,isBodyEmpty:false,children:},{_id:5d56a851f1a7b3002df9de5e,createdAt:2019-08-16T12:57:53.049Z,category:5d569fa6251176006d5c0d2b,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:rbm-getting-started,type:basic,title:Getting Started,parentDoc:null,isBodyEmpty:false,children:{_id:5d56ae5c26dd7d0043584f1a,createdAt:2019-08-16T13:23:40.604Z,category:5d569fa6251176006d5c0d2b,parentDoc:5d56a851f1a7b3002df9de5e,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:rbm-getting-started-create-agent,type:basic,title:Create RBM Channel,isBodyEmpty:false,children:},{_id:5d5967529465a2004afb6958,createdAt:2019-08-18T14:57:22.104Z,category:5d569fa6251176006d5c0d2b,parentDoc:5d56a851f1a7b3002df9de5e,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:rbm-getting-started-send-message,type:basic,title:Send Message,isBodyEmpty:false,children:},{_id:5d5a63a70810f10050791cf1,createdAt:2019-08-19T08:53:59.885Z,category:5d569fa6251176006d5c0d2b,parentDoc:5d56a851f1a7b3002df9de5e,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:rbm-getting-started-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:}},{_id:5d667bc01c274d005c0ba173,createdAt:2019-08-28T13:04:00.907Z,category:5d569fa6251176006d5c0d2b,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:rbm-launching-the-agent,type:basic,title:Launching the Agent,parentDoc:null,isBodyEmpty:false,children:},{_id:5d5913328a3868001fbd09c4,createdAt:2019-08-18T08:58:26.996Z,category:5d569fa6251176006d5c0d2b,parentDoc:null,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:rbm-register-test-device,type:basic,title:Register Test Device,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:5d2c76b7059ba7014799b44d,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2019-07-15T12:51:03.724Z,order:6,slug:telegram-1,title:Telegram,__v:0,pages:{_id:5d2c76cf4c60cf004e5e8789,createdAt:2019-07-15T12:51:27.102Z,category:5d2c76b7059ba7014799b44d,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:telegram,type:basic,title:Telegram,parentDoc:null,isBodyEmpty:false,children:},{_id:5d2c7ce5be6dfb003c750f3c,createdAt:2019-07-15T13:17:25.962Z,category:5d2c76b7059ba7014799b44d,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:telegram-getting-started,type:basic,title:Getting Started,parentDoc:null,isBodyEmpty:false,children:{_id:5d2c7f438b3baf00119f57a2,createdAt:2019-07-15T13:27:31.829Z,category:5d2c76b7059ba7014799b44d,parentDoc:5d2c7ce5be6dfb003c750f3c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:telegram-getting-started-connect-telegram-bot,type:basic,title:Connect Telegram Bot,isBodyEmpty:false,children:},{_id:5d2c87ea4c49ab0073759a53,createdAt:2019-07-15T14:04:26.792Z,category:5d2c76b7059ba7014799b44d,parentDoc:5d2c7ce5be6dfb003c750f3c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:telegram-getting-started-send-message,type:basic,title:Send Message,isBodyEmpty:false,children:},{_id:5d2c8468c3634f002c896e26,createdAt:2019-07-15T13:49:28.717Z,category:5d2c76b7059ba7014799b44d,parentDoc:5d2c7ce5be6dfb003c750f3c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:telegram-getting-started-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:}},{_id:5d2c89e5382ec5001e455fc0,createdAt:2019-07-15T14:12:53.635Z,category:5d2c76b7059ba7014799b44d,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:telegram-entry-points,type:basic,title:Entry Points,parentDoc:null,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b92e,reference:false,from_sync:false,__v:0,project:584bd29609104d23007d9ec9,isAPI:false,createdAt:2017-05-11T09:41:01.249Z,order:7,slug:viber-1,title:Viber,version:59fc42803cf718001069b9ab,pages:{_id:59fc42803cf718001069b985,slug:viber,api:{auth:required,params:,url:,method:get,results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}}},createdAt:2017-05-12T06:49:40.310Z,isReference:false,type:basic,category:59fc42803cf718001069b92e,link_url:,order:0,title:Viber,hidden:false,link_external:false,parentDoc:null,sync_unique:,isBodyEmpty:false,children:},{_id:5a55f939d0cb660012505f32,category:59fc42803cf718001069b92e,createdAt:2018-01-10T11:30:01.635Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:viber-getting-started-viber-bot,type:basic,title:Getting Started - Viber Bot,parentDoc:null,isBodyEmpty:false,children:{_id:5b6c5a8ebba1100003ff524c,category:59fc42803cf718001069b92e,parentDoc:5a55f939d0cb660012505f32,createdAt:2018-08-09T15:15:26.147Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:viber-getting-started-viber-bot-connect-viber-bot-account,type:basic,title:Connect Viber Bot Account,isBodyEmpty:false,children:},{_id:5a58bd262e799c003047b583,category:59fc42803cf718001069b92e,parentDoc:5a55f939d0cb660012505f32,createdAt:2018-01-12T13:50:30.366Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:viber-getting-started-viber-bot-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:},{_id:5a58c00c086a05001c431f6c,category:59fc42803cf718001069b92e,parentDoc:5a55f939d0cb660012505f32,createdAt:2018-01-12T14:02:52.235Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:viber-getting-started-viber-bot-send-message,type:basic,title:Send Message,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:5b6d837a73acbe000364a3d0,category:59fc42803cf718001069b92e,createdAt:2018-08-10T12:22:18.180Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:viber-getting-started-viber-business-messages,type:basic,title:Getting Started - Viber Business Messages,parentDoc:null,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:{_id:5b71909a6711770003dbd1d0,category:59fc42803cf718001069b92e,parentDoc:5b6d837a73acbe000364a3d0,createdAt:2018-08-13T14:07:22.052Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:viber-getting-started-viber-business-messages-connect,type:basic,title:Connect Viber Business Messages,isBodyEmpty:false,children:},{_id:5b6d83c6ebb22e0003051795,category:59fc42803cf718001069b92e,parentDoc:5b6d837a73acbe000364a3d0,createdAt:2018-08-10T12:23:34.410Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:viber-getting-started-viber-business-messages-send-message,type:basic,title:Send Message,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b8fd0803b94c30003bc9fd2,category:59fc42803cf718001069b92e,parentDoc:5b6d837a73acbe000364a3d0,createdAt:2018-09-05T12:48:00.567Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:viber-getting-started-viber-business-messages-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:}},{_id:5a58a28afe845d001253ea97,category:59fc42803cf718001069b92e,createdAt:2018-01-12T11:56:58.937Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:viber-entry-points,type:basic,title:Entry Points,parentDoc:null,isBodyEmpty:false,children:{_id:5a58a36eec04490032eb9cfb,category:59fc42803cf718001069b92e,parentDoc:5a58a28afe845d001253ea97,createdAt:2018-01-12T12:00:46.135Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:false,order:0,slug:viber-entry-points-bot-links,type:basic,title:Viber Bot Links,deprecated:false,icon:,previousSlug:,isBodyEmpty:false,children:},{_id:5a58b113ec04490032eb9eaa,category:59fc42803cf718001069b92e,parentDoc:5a58a28afe845d001253ea97,createdAt:2018-01-12T12:58:59.391Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:viber-entry-points-using-phone-number,type:basic,title:Using Phone Number,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}}},{_id:5d93554cc986080018662575,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2019-10-01T13:31:56.356Z,order:8,slug:whatsapp-2,title:WhatsApp,__v:0,pages:{_id:5d93556a85a9c8003168b443,createdAt:2019-10-01T13:32:26.953Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:whatsapp,type:basic,title:WhatsApp,parentDoc:null,isBodyEmpty:false,children:{_id:5da03a9df28e2c00257cb792,createdAt:2019-10-11T08:17:33.184Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:whatsapp-business-account,type:basic,title:WhatsApp Business Account,parentDoc:5d93556a85a9c8003168b443,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5da0351f69a3790071cba2c9,createdAt:2019-10-11T07:54:07.659Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:whatsapp-eligible-phone-numbers,type:basic,title:Eligible Phone Numbers,parentDoc:5d93556a85a9c8003168b443,isBodyEmpty:false,children:},{_id:63b295f8c29e5f004c06f1e2,api:{method:get,url:,auth:required,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},params:,examples:{codes:}},title:Account Registration,icon:,type:basic,slug:business-account-registration-cloud-api,order:2,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d93556a85a9c8003168b443,category:5d93554cc986080018662575,createdAt:2023-01-02T08:29:44.648Z,isBodyEmpty:false,children:},{_id:60ffc3cd950fca002a73d222,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Porting a Phone Number,type:basic,slug:porting-a-phone-number,order:4,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2021-07-27T08:29:01.221Z,parentDoc:5d93556a85a9c8003168b443,category:5d93554cc986080018662575,isBodyEmpty:false,children:},{_id:61324d2c05fce00062b701ac,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:WhatsApp Pricing 💲,type:basic,slug:whatsapp-pricing,order:5,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2021-09-03T16:28:28.033Z,parentDoc:5d93556a85a9c8003168b443,category:5d93554cc986080018662575,isBodyEmpty:false,children:},{_id:682ddfe30928bf0018b1de66,mdx:{},api:{method:get,url:,auth:required,params:},title:Migration: From API to app,icon:,type:basic,slug:from-api-to-app,order:7,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d93556a85a9c8003168b443,category:5d93554cc986080018662575,createdAt:2025-05-21T14:14:59.600Z,isBodyEmpty:false,children:}},{_id:5da04e47c6eb85006da40474,createdAt:2019-10-11T09:41:27.645Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:whatsapp-entry-points,type:basic,title:Entry Points,parentDoc:null,isBodyEmpty:false,children:{_id:5da052c816bc3c003a92e80f,createdAt:2019-10-11T10:00:40.999Z,parentDoc:5da04e47c6eb85006da40474,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:opt-in-for-whatsapp,type:basic,title:Opt-in for WhatsApp,isBodyEmpty:false,children:}},{_id:5da07960e15930004889acfd,createdAt:2019-10-11T12:45:20.275Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:whatsapp-policy,type:basic,title:Policy,parentDoc:null,isBodyEmpty:false,children:}},{_id:5bd9acb4608df7005518e47f,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2018-10-31T13:23:00.786Z,order:9,slug:integrations,title:Integrations - Help Desks,__v:0,pages:{_id:63203f59ef63830071441fa0,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Daktela - Webchat,icon:,type:basic,slug:daktela,order:0,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-09-13T08:29:13.098Z,category:5bd9acb4608df7005518e47f,parentDoc:null,isBodyEmpty:false,children:},{_id:644b4a8b517cfd000b801142,api:{method:get,url:,auth:required,params:},title:Daktela - Email,icon:,type:basic,slug:daktela-email,order:1,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:5bd9acb4608df7005518e47f,createdAt:2023-04-28T04:24:43.889Z,parentDoc:null,isBodyEmpty:false,children:},{_id:63aac9855315f0004b0223b0,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:FreshWorks (FreshChat),icon:,type:basic,slug:freshworks,order:2,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:5bd9acb4608df7005518e47f,createdAt:2022-12-27T10:31:33.384Z,parentDoc:null,mdx:{},isBodyEmpty:false,children:},{_id:65193cd0a20b64003beca5ef,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:Salesforce,icon:,type:basic,slug:salesforce-webchat,order:3,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:5bd9acb4608df7005518e47f,createdAt:2023-10-01T09:33:04.116Z,parentDoc:null,isBodyEmpty:false,children:},{_id:6656ea457568a30018e5bd0b,api:{method:get,url:,auth:required,params:},title:Front,icon:,type:basic,slug:front,order:4,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:5bd9acb4608df7005518e47f,createdAt:2024-05-29T08:41:41.102Z,parentDoc:null,isBodyEmpty:false,children:}},{_id:68c16049f45d950727146b92,title:Integrations - E-commerce Platforms,version:59fc42803cf718001069b9ab,project:584bd29609104d23007d9ec9,slug:integrations-,order:10,reference:false,createdAt:2025-09-10T11:26:01.343Z,__v:0,pages:{_id:68c160c7eb2795f82c63317e,title:Shopify,icon:,type:basic,slug:shopify,mdx:{},category:68c16049f45d950727146b92,order:999,isReference:false,deprecated:false,api:{method:get,url:,auth:required,params:},hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2025-09-10T11:28:07.156Z,isBodyEmpty:false,children:}},refs:{_id:59fc42803cf718001069b924,slug:api-endpoints,sync:{url:,isSync:false},title:Introduction,project:584bd29609104d23007d9ec9,createdAt:2016-12-10T11:20:37.914Z,from_sync:false,order:0,reference:true,version:59fc42803cf718001069b9ab,__v:0,pages:{_id:59fc42803cf718001069b93c,createdAt:2016-12-21T07:47:16.515Z,isReference:true,sync_unique:,parentDoc:null,type:basic,category:59fc42803cf718001069b924,link_external:false,order:0,link_url:,slug:introduction,title:Introduction,api:{settings:,url:,apiSetting:null,auth:required,params:,results:{codes:{status:200,language:json,code:{},name:},{language:json,code:{},name:,status:400}},method:get},hidden:false,previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b938,link_external:false,order:1,type:basic,createdAt:2016-12-19T09:52:06.749Z,hidden:false,link_url:,parentDoc:null,sync_unique:,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,method:get,params:},slug:authentication,title:Authentication,category:59fc42803cf718001069b924,isReference:true,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b93d,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,method:get,params:},link_url:,slug:requests,type:basic,category:59fc42803cf718001069b924,createdAt:2016-12-21T08:57:31.682Z,sync_unique:,isReference:true,link_external:false,order:2,hidden:false,parentDoc:null,title:Requests,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b93e,sync_unique:,type:basic,slug:responses,category:59fc42803cf718001069b924,order:3,parentDoc:null,link_url:,title:Responses,api:{url:,auth:required,method:get,params:,results:{codes:{code:{},name:,status:200,language:json},{status:400,language:json,code:{},name:}},settings:},createdAt:2016-12-21T08:57:38.910Z,hidden:false,link_external:false,isReference:true,isBodyEmpty:false,children:{_id:59fc42803cf718001069b94f,hidden:false,link_external:false,slug:errors,api:{auth:required,method:get,params:,results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},settings:,url:},createdAt:2017-01-04T13:34:10.863Z,order:0,sync_unique:,category:59fc42803cf718001069b924,link_url:,parentDoc:59fc42803cf718001069b93e,isReference:true,title:Errors,type:basic,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b93f,type:basic,api:{auth:required,method:get,params:,results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,url:},category:59fc42803cf718001069b924,link_external:false,order:4,title:Pagination,link_url:,isReference:true,createdAt:2016-12-21T09:40:51.426Z,hidden:false,parentDoc:null,slug:pagination,sync_unique:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b971,category:59fc42803cf718001069b924,createdAt:2017-04-07T12:43:04.358Z,isReference:true,sync_unique:,link_url:,slug:rate-limiting,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{name:,status:400,language:json,code:{}}},auth:required},hidden:false,link_external:false,type:basic,order:5,parentDoc:null,title:Rate Limiting,isBodyEmpty:false,children:},{_id:5c3f47308fd6fb0038787cbf,category:59fc42803cf718001069b924,createdAt:2019-01-16T15:01:04.137Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:6,slug:locale,type:basic,title:Locale,parentDoc:null,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b925,slug:webhooks,version:59fc42803cf718001069b9ab,__v:0,createdAt:2016-12-10T11:20:48.353Z,reference:true,sync:{url:,isSync:false},title:API Reference,from_sync:false,order:1,project:584bd29609104d23007d9ec9,pages:{_id:59fc42803cf718001069b940,hidden:false,slug:messages,type:basic,api:{settings:,url:,auth:required,method:get,params:,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}}},createdAt:2016-12-21T11:26:20.166Z,category:59fc42803cf718001069b925,isReference:true,order:0,parentDoc:null,title:Messages,sync_unique:,link_external:false,link_url:,isBodyEmpty:false,children:{_id:5a706c60b3c9580024d1a257,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b940,createdAt:2018-01-30T13:00:16.087Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \payload\: \{{CONTENT_TYPE}}\,\n \type\: \{{CONTENT_PAYLOAD}}\\n }\n }\n,language:json,status:200}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a706ff82c5b7f007bf7fc66},{name:contact_id,type:string,enumValues:,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5a706ff82c5b7f007bf7fc65},{name:max,type:int,enumValues:,default:10,desc:Maximum number of messages to be listed. Values larger than 100 are accepted but the list will never contain more than 100 messages. (default is 10),required:false,in:query,ref:,_id:60c899b9ebf23301cc344ce8},{name:offset,type:int,enumValues:,default:0,desc:Offset of the starting position in the message list.,required:false,in:query,ref:,_id:60c899b9ebf23301cc344ce7},{name:since,type:string,enumValues:,default:,desc:Allows filtering messages by date. Must be in ISO 8601 format.,required:false,in:query,ref:,_id:60c899b9ebf23301cc344ce6},{name:before,type:string,enumValues:,default:,desc:Allows filtering messages by date. Must be in ISO 8601 format.,required:false,in:query,ref:,_id:60c899b9ebf23301cc344ce5},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get,apiSetting:5d8ac5fa5478da001f7f3533,examples:{codes:{code:curl --request GET \\\n --url https://api.amio.io/v1/channels/{{channel_id}}/contacts/{{contact_id}}/messages,language:curl}}},isReference:true,order:0,slug:messages-list-messages,type:endpoint,title:List Messages,previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b93b,parentDoc:59fc42803cf718001069b940,api:{url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \{{CONTENT_TYPE}}\,\n \payload\: \{{CONTENT_PAYLOAD}}\\n }\n}}},method:post,params:{name:channel.id,type:string,default:,desc:Id of the channel you wish to send the message to. You can get channel id in administration.,required:true,in:body,ref:,_id:586a5a05e272d81900733a6c},{name:contact.id,type:string,default:,desc:Id of the contact you wish to send the message to. There are different ways how to a contact (they are typically specific to a channel type), see Platform Specific Requests(ref:messages-platform-specific-requests) for more details.,required:true,in:body,ref:,_id:58d271a5eb285919003337c1},{name:content.type,type:string,default:,desc:Different types of the content can be sent: `text`, `file`, `audio`, `video` and `image`, `structure`, etc. See Platform Specific Requests(ref:messages-platform-specific-requests) for more detail.,required:true,in:body,ref:,_id:586a5aa679f1b92500e92594},{name:content.payload,type:string,default:,desc:Payload is specific to message type. Different message types are documented in Platform Specific Requests(ref:messages-platform-specific-requests).,required:true,in:body,ref:,_id:586a5aa679f1b92500e92593},{name:metadata,type:object,default:,desc:Metadata(ref:messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a16a555fff719001ee14657},results:{codes:{status:201,language:json,code:{\n \id\: \{{MESSAGE_ID}}\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \{{CONTENT_TYPE}}\,\n \payload\: \{{CONTENT_PAYLOAD}}\\n }\n},name:}},settings:,apiSetting:5d8ac5fa5478da001f7f3533},category:59fc42803cf718001069b925,createdAt:2016-12-20T10:29:34.787Z,hidden:false,link_url:,slug:messages-send-message,sync_unique:,order:1,title:Send Message,type:endpoint,isReference:true,link_external:false,previousSlug:,isBodyEmpty:false,children:},{_id:5a16a578f7b5a0001e036c01,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b940,createdAt:2017-11-23T10:39:52.356Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:2,slug:messages-metadata,type:basic,title:Metadata,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:5a296fa7842c120012bd7ed3,category:59fc42803cf718001069b925,createdAt:2017-12-07T16:43:19.147Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:notifications,type:basic,title:Notifications,parentDoc:null,isBodyEmpty:false,children:{_id:5a297133ec2b8400128ed5e0,category:59fc42803cf718001069b925,parentDoc:5a296fa7842c120012bd7ed3,createdAt:2017-12-07T16:49:55.461Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,settings:,results:{codes:{status:200,language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \type\: \{{NOTIFICATION_TYPE}}\\n},name:}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\,\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \type\: \{{NOTIFICATION_TYPE}}\\n},language:json}},auth:required,params:{_id:586a5a05e272d81900733a6c,ref:,in:body,required:true,desc:Id of the channel you wish to send the notification to. You can get channel id in administration.,default:,type:string,name:channel.id},{_id:58d271a5eb285919003337c1,ref:,in:body,required:true,desc:Id of the contact you wish to send the notification to. There are different ways how to a contact (they are typically specific to a channel type), see Platform Specific Requests(ref:messages-platform-specific-requests) for more details.,default:,type:string,name:contact.id},{_id:586a5aa679f1b92500e92594,ref:,in:body,required:true,desc:Type specifies the notification to be sent they are different in each platform, see Platform Specific Requests(ref:notifications-platform-specific-requests).,default:,type:string,name:type},url:/v1/notifications,method:post},isReference:true,order:0,slug:notifications-send-notification,type:endpoint,title:Send Notification,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b957,hidden:false,slug:channels,type:basic,createdAt:2017-03-22T11:31:32.959Z,isReference:true,link_url:,parentDoc:null,sync_unique:,title:Channels,category:59fc42803cf718001069b925,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required},order:2,link_external:false,isBodyEmpty:false,children:{_id:59fc42803cf718001069b9aa,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b957,createdAt:2017-10-27T12:47:49.173Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,results:{codes:{name:OK,code:\n {\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n }\n\n,language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1c3c73c73b44001ed598e2,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b957,createdAt:2017-11-27T16:25:23.356Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n},language:json,status:200}},apiSetting:5d8ac5fa5478da001f7f3533,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1c3c73c73b44001ed598e3},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1c3f2d9b53b8001e82bf86,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b957,createdAt:2017-11-27T16:37:01.194Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n }\n},language:json,status:201}},examples:{codes:{language:json,code:{\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\ \n }\n}}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type specifying the underlying platform: `amio_chat`, `email`, `facebook_messenger`, `mobile`, `rbm`, `telegram`, `viber`, `viber_business_messages`, `whatsapp`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be automatically filled with an account name of underlying platform.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Allowed values depends on the channel type.,required:false,in:body,ref:,_id:5d5c22d5f20ff50052c03fc6},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3bdac9c7824200187266a4},url:/v1/channels,method:post},isReference:true,order:2,slug:channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1c45f769b8660032b4e125,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b957,createdAt:2017-11-27T17:05:59.462Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \0jOPqX32hDS5AGKOcGRH\\n }\n}}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \0jOPqX32hDS5AGKOcGRH\,\n \ssl_verification\: true\n }\n},name:OK}},apiSetting:5d8ac5fa5478da001f7f3533,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1c4646c73b44001ed59a0e},{name:name,type:string,enumValues:,default:,desc:Name of the channel.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Allowed values depends on the channel type.,required:false,in:body,ref:,_id:5d5c217bb190700116512f37},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3bd596a148d100323c6599},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b95a,createdAt:2017-03-23T08:13:05.620Z,link_external:false,slug:channels-delete-channel,sync_unique:,link_url:,parentDoc:59fc42803cf718001069b957,type:endpoint,category:59fc42803cf718001069b925,hidden:false,order:4,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},url:/v1/channels/{channel_id},auth:required,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},method:delete,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},apiSetting:5d8ac5fa5478da001f7f3533},isReference:true,title:Delete Channel,isBodyEmpty:true,children:}},{_id:59fc42803cf718001069b9a7,category:59fc42803cf718001069b925,createdAt:2017-10-27T11:45:06.616Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:59fc42803cf718001069b9a8,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b9a7,createdAt:2017-10-27T11:56:57.933Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5a0aa45d2aad4d001ad60ccf,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b9a7,createdAt:2017-11-14T08:07:57.994Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\\n},name:OK}},apiSetting:5d8ac5fa5478da001f7f3533,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:contacts-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b9a9,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b9a7,createdAt:2017-10-27T12:20:40.429Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:false,children:}},{_id:5a2a68b888574d001e9932f1,category:59fc42803cf718001069b925,createdAt:2017-12-08T10:26:00.623Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:settings,type:basic,title:Settings,parentDoc:null,isBodyEmpty:false,children:{_id:5a2a6e8ee25025003c5827a4,category:59fc42803cf718001069b925,parentDoc:5a2a68b888574d001e9932f1,createdAt:2017-12-08T10:50:54.887Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/settings,language:curl}},results:{codes:{status:200,language:json,code:{\n {{PLATFORM_SPECIFIC_SETTINGS}}\n},name:OK}},apiSetting:5d8ac5fa5478da001f7f3533,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:get},isReference:true,order:0,slug:settings-get-settings,type:endpoint,title:Get Settings,isBodyEmpty:true,children:},{_id:5a2a6c60bb0df5001c86d470,category:59fc42803cf718001069b925,parentDoc:5a2a68b888574d001e9932f1,createdAt:2017-12-08T10:41:36.592Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:{\n {{PLATFORM_SPECIFIC_SETTINGS}}\n},language:json,status:200},{name:,code:{},language:json,status:400}},auth:required,params:{_id:5a2a6da288574d001e993315,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:patch,apiSetting:5d8ac5fa5478da001f7f3533,examples:{codes:{code:{\n {{PLATFORM_SPECIFIC_SETTINGS}}\n},language:json}}},isReference:true,order:1,slug:settings-update-settings,type:endpoint,title:Update Settings,isBodyEmpty:true,children:}}},{_id:59fc42803cf718001069b928,slug:webhooks-1,project:584bd29609104d23007d9ec9,sync:{isSync:false,url:},reference:true,createdAt:2016-12-21T08:50:34.879Z,from_sync:false,version:59fc42803cf718001069b9ab,order:2,title:Webhooks,__v:0,pages:{_id:59fc42803cf718001069b935,hidden:false,sync_unique:,category:59fc42803cf718001069b928,parentDoc:null,isReference:true,order:0,slug:webhooks,type:basic,createdAt:2016-12-10T11:26:37.307Z,api:{examples:{codes:{language:text,code:// asd fdsalk fj;ldsa jfldsaf}},method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:/:version/m,auth:required},link_external:false,link_url:,title:Webhooks,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b941,createdAt:2016-12-21T11:45:11.712Z,link_external:false,order:1,category:59fc42803cf718001069b928,link_url:,parentDoc:null,sync_unique:,api:{auth:required,method:get,params:,results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},settings:,url:},isReference:true,slug:events,type:basic,title:Events,hidden:false,isBodyEmpty:false,children:{_id:59fc42803cf718001069b944,parentDoc:59fc42803cf718001069b941,createdAt:2016-12-21T12:48:28.345Z,isReference:true,link_url:,slug:events-message-received,api:{params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,method:get,examples:{codes:}},category:59fc42803cf718001069b928,sync_unique:,type:basic,link_external:false,title:Message Received,hidden:false,order:0,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42bf77dc0a0010000c1a,category:59fc42803cf718001069b928,parentDoc:59fc42803cf718001069b941,createdAt:2017-11-03T10:19:43.341Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:events-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5b1008cc4b213d0003829340,category:59fc42803cf718001069b928,parentDoc:59fc42803cf718001069b941,createdAt:2018-05-31T14:38:04.423Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:events-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:59fc4ebf3cf718001069baab,category:59fc42803cf718001069b928,parentDoc:59fc42803cf718001069b941,createdAt:2017-11-03T11:10:55.888Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:3,slug:events-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b955,createdAt:2017-03-06T19:11:02.320Z,hidden:false,link_external:false,link_url:,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,examples:{codes:}},title:Message Echo,slug:events-message-echo,sync_unique:,type:basic,category:59fc42803cf718001069b928,isReference:true,order:4,parentDoc:59fc42803cf718001069b941,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b94d,sync_unique:,isReference:true,link_url:,order:5,title:Channel Events,category:59fc42803cf718001069b928,hidden:false,createdAt:2017-01-02T15:13:51.591Z,link_external:false,parentDoc:59fc42803cf718001069b941,slug:events-channel-events,api:{auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:},type:basic,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b942,category:59fc42803cf718001069b928,isReference:true,link_url:,parentDoc:null,slug:security,api:{method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:,auth:required},createdAt:2016-12-21T11:45:32.635Z,hidden:false,link_external:false,order:2,sync_unique:,title:Security,type:basic,isBodyEmpty:false,children:}},{_id:5c9b6d0ba42eb00024b4af2c,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2019-03-27T12:31:07.549Z,order:3,slug:amio-chat,title:Amio Chat,__v:0,pages:{_id:5c9b6d2fe5e6e6001e15ee6b,createdAt:2019-03-27T12:31:43.784Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-amio-chat,type:basic,title:Amio Chat,parentDoc:null,isBodyEmpty:false,children:},{_id:5c9b6ea5bb4936000e749905,createdAt:2019-03-27T12:37:57.751Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:amio-chat-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5c9b6fc75302ae00431f45ad,createdAt:2019-03-27T12:42:47.660Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b6ea5bb4936000e749905,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331248741/contacts/6456078781510715474/messages,language:curl}},apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{name:,code:\n {\n \id\: \6456078996108099701\,\n \direction\: \sent\,\n \sent\: \2019-03-27T13:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331248741\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n }\n,language:json,status:200}},auth:required,params:{_id:5a706ff82c5b7f007bf7fc66,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a706ff82c5b7f007bf7fc65,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:amio-chat-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:false,children:},{_id:5c9b72796cd20e00141e4209,createdAt:2019-03-27T12:54:17.922Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b6ea5bb4936000e749905,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108099701\,\n \channel\: {\n \id\: \6456078759331248741\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:null}},examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331248741\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},settings:,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 1000 characters.,default:,type:string,name:content.payload},{_id:5e42679eee3fb80012cea750,ref:,in:body,required:false,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5e4268663f2716002a195e02,ref:,in:body,required:false,desc:Metadata(ref:amio-chat-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:1,slug:amio-chat-messages-text,type:endpoint,title:Text,isBodyEmpty:true,children:},{_id:5c9b7b19065d190063a4a0eb,createdAt:2019-03-27T13:31:05.011Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b6ea5bb4936000e749905,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5e426a35dd81f5001b88b66e,settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108099701\,\n \channel\: {\n \id\: \6456078759331248741\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},name:}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331248741\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:content.payload.url},{_id:5e4267fc21a9040154db2bf6,ref:,in:body,required:false,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5e42684b5e1c780019935aa0,ref:,in:body,required:false,desc:Metadata(ref:amio-chat-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages/,method:post},isReference:true,order:3,slug:amio-chat-messages-image,type:endpoint,title:Image,isBodyEmpty:true,children:},{_id:5e426fd5d6f538004f2a2fda,parentDoc:5c9b6ea5bb4936000e749905,category:5c9b6d0ba42eb00024b4af2c,createdAt:2020-02-11T01:14:52.039Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5e426de8bedf32005fb53c27,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.title,type:string,enumValues:,default:,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`. You can also omit the title attribute and use only `text` and `buttons` attributes.,required:false,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. **Max size** 80 characters. However, you can use **up to 640 characters** if you use text with buttons only.,required:false,in:body,ref:,_id:585b96556399952d00e0ac38},{name:content.payload.image_url,type:string,enumValues:,default:,desc:Url of an image to be displayed. Image ratio is 1.91:1.,required:false,in:body,ref:,_id:585b96556399952d00e0ac37},{name:content.payload.item_url,type:string,enumValues:,default:,desc:Url which is opened when the message is tapped.,required:false,in:body,ref:,_id:585b96556399952d00e0ac36},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:false,in:body,ref:,_id:585b96556399952d00e0ac35},{name:content.quick_replies,type:object,enumValues:,default:,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,required:false,in:body,ref:,_id:5e427056bedf32005fb53c4d},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:amio-chat-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a58e527791cac001c857652},url:/v1/messages,method:post},isReference:true,order:4,slug:amio-chat-messages-structure,type:endpoint,title:Structure,deprecated:false,icon:,previousSlug:,isBodyEmpty:false,children:},{_id:5e42712463f8090073f32c02,parentDoc:5c9b6ea5bb4936000e749905,category:5c9b6d0ba42eb00024b4af2c,createdAt:2020-02-11T01:14:50.716Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5e4270a063f8090073f32bfa,settings:,results:{codes:{name:,status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger with Coleslaw salad\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n}}},examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger with Coleslaw salad\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n}}},auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.title,type:string,enumValues:,default:,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`.,required:true,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. **Max size** 80 characters.,required:false,in:body,ref:,_id:585b96556399952d00e0ac38},{name:content.payload.image_url,type:string,enumValues:,default:,desc:Url of an image to be displayed. Image ratio is 1.91:1.,required:false,in:body,ref:,_id:585b96556399952d00e0ac37},{name:content.payload.item_url,type:string,enumValues:,default:,desc:Url which is opened when the message is tapped.,required:false,in:body,ref:,_id:585b96556399952d00e0ac36},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:false,in:body,ref:,_id:585b96556399952d00e0ac35},{name:content.quick_replies,type:object,enumValues:,default:,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,required:false,in:body,ref:,_id:5e427179930618004829a92e},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:amio-chat-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a16a40228bd9b0012b3da22},url:/v1/messages,method:post},isReference:true,order:5,slug:amio-chat-messages-structure-horizontal,type:endpoint,title:Structure - Horizontal Scroll,deprecated:false,icon:,previousSlug:,isBodyEmpty:true,children:},{_id:5e4265735e1c7800199359fa,parentDoc:5c9b6ea5bb4936000e749905,category:5c9b6d0ba42eb00024b4af2c,createdAt:2020-02-11T01:14:51.856Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,examples:{codes:},auth:required,params:,url:,method:get},isReference:true,order:6,slug:amio-chat-messages-quick-replies,type:basic,title:Quick Replies,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9c955da6b59f013bbd7030,createdAt:2019-03-28T09:35:25.990Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b6ea5bb4936000e749905,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:7,slug:amio-chat-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:}},{_id:5c9b7c8d8191a00284a1ce75,createdAt:2019-03-27T13:37:17.160Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:amio-chat-notifications,type:basic,title:Notifications,parentDoc:null,isBodyEmpty:false,children:{_id:5c9b7dd082c4d90039ce67d0,createdAt:2019-03-27T13:42:40.361Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b7c8d8191a00284a1ce75,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331248741\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \type\: \custom\,\n \payload\: {\n \any\: \arbitrary data\\n }\n}}},results:{codes:{status:200,language:json,code:{\n \channel\: {\n \id\: \6456078759331248741\,\n },\n \contact\: {\n \id\: \6456078781510715474\,\n },\n \type\: \custom\,\n \payload\: {\n \any\: \arbitrary data\\n }\n},name:}},settings:,apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{_id:586a5a05e272d81900733a6c,ref:,in:body,required:true,desc:Id of the channel you wish to send the notification to. You can get channel id in administration.,default:,type:string,name:channel.id},{_id:58d271a5eb285919003337c1,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:5a141672e6f0d3001eeceaee,ref:,in:body,required:true,desc:Type specifies the notification to be sent and can have following values:\u003cbr />- `messages_read` - Notifies that all received messages from contact are read.\u003cbr />- `typing_on` - Notifies that the typing indicator should be shown.\u003cbr />- `typing_off` - Notifies that the typing indicator should be hidden.\u003cbr />- `custom` - Any arbitrary notification to be sent. This notification type can contain any arbitrary data sent in `payload`.,default:,type:string,name:type},{_id:5c9b8e448212350186c203ec,ref:,in:body,required:false,desc:Payload is used for `custom` notification type and can contain any arbitrary data.,default:,type:object,name:payload},url:/v1/notifications,method:post},isReference:true,order:0,slug:amio-chat-notifications-send-notification,type:endpoint,title:Send Notification,isBodyEmpty:true,children:}},{_id:5c9b8eae0d3da2001bea412f,createdAt:2019-03-27T14:54:38.225Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:amio-chat-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5c9b8eebbb4936000e749ede,createdAt:2019-03-27T14:55:39.931Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{name:OK,code:\n {\n \id\: \6456078996108099701\,\n \type\: \amio_chat\,\n \name\: \Amio Chat\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n }\n,language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:amio-chat-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9b92776cd20e00141e460c,createdAt:2019-03-27T15:10:47.150Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078996108099701,language:curl}},results:{codes:{name:OK,code:{\n \id\: \6456078996108099701\,\n \type\: \amio_chat\,\n \name\: \Amio Chat\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n},language:json,status:200}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:,url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:amio-chat-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9b93176af65001910a55ad,createdAt:2019-03-27T15:13:28.056Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{name:OK,code:{\n \id\: \6456078996108099701\,\n \type\: \amio_chat\,\n \name\: \Amio Chat\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n }\n},language:json,status:201}},examples:{codes:{code:{\n \type\: \amio_chat\,\n \name\: \Amio Chat\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\ \n }\n},language:json}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `amio_chat`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will generate one.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5c234059e629010a0aa04e},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3bfcad0c8f670012be51ad},url:/v1/channels,method:post},isReference:true,order:2,slug:amio-chat-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9b9a80a0894502f17bd498,createdAt:2019-03-27T15:45:04.413Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n }\n},language:json}},results:{codes:{name:OK,code:{\n \id\: \6456078759331248741\,\n \type\: \amio_chat\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n},language:json,status:200}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d3fd59d3741002afd488d},{name:name,type:string,enumValues:,default:,desc:Name of the channel. Can be an arbitrary name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5c2371cd821a0027d93210},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3bfda6d2a41a004e6f1b79},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:amio-chat-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9b9bcdc05597037ce30784,createdAt:2019-03-27T15:50:37.283Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331248741,language:curl}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:amio-chat-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5c9b9fa9a78b2f005ddb9652,createdAt:2019-03-27T16:07:05.433Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:amio-chat-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5c9ba08976478e004b9a09d7,createdAt:2019-03-27T16:10:49.241Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b9fa9a78b2f005ddb9652,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510715474\,\n \name\: \6456078781510715474\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331248741/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:amio-chat-contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5c9ba34a87e204000e23bd13,createdAt:2019-03-27T16:22:34.890Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b9fa9a78b2f005ddb9652,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331248741/contacts/6456078781510715474,name:cUrl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510715474\,\n \name\: \6456078781510715474\\n},name:OK}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:amio-chat-contacts-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5c9ba392bb4936000e74a1d4,createdAt:2019-03-27T16:23:46.157Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b9fa9a78b2f005ddb9652,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331248741/contacts/6456078781510715474,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:amio-chat-contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5c9ba822fcffa30307e45d75,createdAt:2019-03-27T16:43:14.834Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:amio-chat-settings,type:basic,title:Settings,parentDoc:null,isBodyEmpty:false,children:{_id:5c9ba9c28212350186c20852,createdAt:2019-03-27T16:50:10.520Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9ba822fcffa30307e45d75,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331248741/settings,language:curl}},results:{codes:{status:200,language:json,code:{\n \domains_whitelist\: \n \https://app.amio.io\\n \n},name:OK}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:get},isReference:true,order:0,slug:amio-chat-settings-get-settings,type:endpoint,title:Get Settings,isBodyEmpty:false,children:},{_id:5c9baa70f7e4aa005da8c56a,createdAt:2019-03-27T16:53:04.892Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9ba822fcffa30307e45d75,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{status:200,language:json,code:{\n \domains_whitelist\: \n \https://app.amio.io\\n \n},name:OK}},examples:{codes:{name:cUrl,code:{\n \domains_whitelist\: \n \https://app.amio.io\\n \n},language:json}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:patch},isReference:true,order:1,slug:amio-chat-settings-update-settings,type:endpoint,title:Update Settings,isBodyEmpty:false,children:},{_id:5c9ba96d6ef40a003fc0c4a1,createdAt:2019-03-27T16:48:45.267Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9ba822fcffa30307e45d75,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:amio-chat-settings-domains-whitelist,type:basic,title:Domains Whitelist,isBodyEmpty:false,children:}},{_id:5c9baeb7bb4936000e74a2fa,createdAt:2019-03-27T17:11:19.613Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,auth:required,params:,url:,method:get},isReference:true,order:6,slug:amio-chat-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5c9baf916cd20e00141e4988,createdAt:2019-03-27T17:14:57.812Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:amio-chat-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9c91c85a6dd1000e881783,createdAt:2019-03-28T09:20:08.852Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:amio-chat-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5c9c9292e7592c005d96492d,createdAt:2019-03-28T09:23:30.825Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:2,slug:amio-chat-webhooks-messages-read,type:basic,title:Messages Read,previousSlug:messages-read,isBodyEmpty:false,children:},{_id:5c9c9489e041200062a3495d,createdAt:2019-03-28T09:31:53.880Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:amio-chat-webhooks-message-echo,type:basic,title:Message Echo,isBodyEmpty:false,children:},{_id:5c9cc01e3dac6900502ccd40,createdAt:2019-03-28T12:37:50.239Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:amio-chat-webhooks-notification-received,type:basic,title:Notification Received,isBodyEmpty:false,children:},{_id:60cc68cf87ccfc0359aa4b7f,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Postback Received,type:basic,slug:amio-chat-webhooks-postback-received,order:5,isReference:true,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:postback-received,createdAt:2021-06-18T09:35:11.294Z,parentDoc:5c9baeb7bb4936000e74a2fa,category:5c9b6d0ba42eb00024b4af2c,isBodyEmpty:false,children:}}},{_id:5dc53a440d5f2d004363aee2,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:true,reference:true,createdAt:2019-11-08T09:49:56.308Z,order:4,slug:email,title:Email - Daktela,__v:0,pages:{_id:5dc53a440d5f2d004363aee3,createdAt:2019-11-08T09:49:56.344Z,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{auth:required,params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}}},isReference:true,order:0,slug:api-email-daktela,type:basic,title:Email - Daktela,parentDoc:null,deprecated:false,icon:,previousSlug:api-email,isBodyEmpty:false,children:},{_id:5dc53b8d1f8feb007286fdb6,createdAt:2019-11-08T09:55:25.060Z,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:email-daktela-messages,type:basic,title:Messages,parentDoc:null,deprecated:false,icon:,previousSlug:email-messages,isBodyEmpty:false,children:{_id:5ddb992c91b2510044df0714,createdAt:2019-11-25T09:04:44.442Z,parentDoc:5dc53b8d1f8feb007286fdb6,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6646948773235533878\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello.\\n }\n}\n,name:JSON}},results:{codes:{name:null,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \email_daktela\\n },\n \contact\: {\n \id\: \6646948773235533878\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello.\\n }\n},language:json,status:201}},settings:,apiSetting:5dc53a440d5f2d004363aee0,auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:,_id:586d2081a63f5d2500c86b83},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `text`.,required:true,in:body,ref:,_id:586d20b39a854123001acd78},{name:content.payload,type:string,enumValues:,default:,desc:Text to be sent. Maximum size is 4096 characters.,required:true,in:body,ref:,_id:586d20b39a854123001acd77},{name:metadata,type:object,enumValues:,default:,desc:,required:false,in:body,ref:,_id:5a16a39a38e7e000128181a6},url:/v1/messages,method:post},isReference:true,order:0,slug:email-daktela-messages-text,type:endpoint,title:Text,deprecated:false,icon:,previousSlug:email-messages-text,isBodyEmpty:false,children:}},{_id:5dd25563231a61005516730f,createdAt:2019-11-18T08:25:07.887Z,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:email-daktela-channels,type:basic,title:Channels,parentDoc:null,deprecated:false,icon:,previousSlug:email-channels,isBodyEmpty:false,children:{_id:5e13466d020bd3004f3c7108,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T05:28:31.770Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078759331238786\,\n \type\: \email_daktela\,\n \name\: \Support Email\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://your-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\,\n \daktela_processed_category\: null\n }\n }\n,name:}},auth:required,params:{name:max,type:int,enumValues:,default:,desc:Maximum number of channels in the response.,required:false,in:query,ref:,_id:642abcf60fca1c024dbb6760},{name:offset,type:int,enumValues:,default:,desc:Offset of the channel list in the response.,required:false,in:query,ref:,_id:642abcf60fca1c024dbb675f},url:/v1/channels,method:get,apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels}}},isReference:true,order:0,slug:email-daktela-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,previousSlug:email-channels-list-channels,mdx:{},isBodyEmpty:false,children:},{_id:5e134839b1196a02ef0edc04,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T13:23:57.656Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786}},apiSetting:5dc53a440d5f2d004363aee0,results:{codes:{status:200,language:json,code: {\n \id\: \6456078759331238786\,\n \type\: \email\,\n \name\: \Support Email\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://your-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\,\n \daktela_processed_category\: null\n }\n}\n,name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e135623f56e02005fcbb1ac},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:email-daktela-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,previousSlug:email-channels-get-channel,mdx:{},isBodyEmpty:false,children:},{_id:5ddbb2311e4e2f00208366cf,createdAt:2019-11-25T10:51:29.847Z,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \type\: \email\,\n \name\: \Support Email\,\n \webhook\: {\n \url\: \https://your-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\\n }\n}\n}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \email\,\n \name\: \Support Email\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://your-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\,\n \daktela_processed_category\: null\n }\n},language:json,status:201}},apiSetting:5dc53a440d5f2d004363aee0,auth:required,params:{name:type,type:string,enumValues:,default:email_daktela,desc:Channel type, `email_daktela`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:Email Daktela,desc:Name of the channel. If not set, it will be `Email Daktela`.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d05bdd4f531001fbc67d1},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c01c1a96b58003961c233},{name:daktela,type:object,enumValues:,default:,desc:Contains Daktela-related configuration.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b7},{name:daktela.access_token,type:string,enumValues:,default:123456789abcdef,desc:Access token of a Daktela user on whose behalf the actions are made.,required:true,in:body,ref:,_id:5dd2605e45075e0065e94919},{name:daktela.daktela_url,type:string,enumValues:,default:https://your-company.daktela.com,desc:URL of Daktela instance.,required:true,in:body,ref:,_id:5dd2605e45075e0065e94918},{name:daktela.daktela_ticket_category,type:string,enumValues:,default:Support,desc:Used during handover to operator - the tickets category will be changed to this value.,required:true,in:body,ref:,_id:5e133e9e05d1a8019c3e60a0},{name:daktela.daktela_user_name,type:string,enumValues:,default:user_name,desc:Optional. Used during handover to operator - the ticket will be assigned to this user.,required:false,in:body,ref:,_id:5e133e9e05d1a8019c3e609f},{name:daktela.daktela_queue,type:string,enumValues:,default:1001,desc:Name of queue in Daktela which this channel is connected to.,required:false,in:body,ref:,_id:646cb8dcec9e7e0dcb317425},{name:daktela.daktela_processed_category,type:string,enumValues:,default:category_12345,desc:Optional. Only process email tickets that have this category set. If `daktela_processed_category`is null, process all emails. If `daktela_processed_category` is \NO_CATEGORY\, process only email tickets without a category.,required:false,in:body,ref:,_id:65e9e2228a8f43003633f283},url:/v1/channels,method:post},isReference:true,order:2,slug:email-daktela-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,previousSlug:email-channels-create-channel,mdx:{},isBodyEmpty:false,children:},{_id:5e13493eb89973001ee3876b,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T04:53:29.257Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \email\,\n \name\: \New Support Email\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://new-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\,\n \daktela_processed_category\: \category_12345\\n }\n},language:json,status:201}},examples:{codes:{language:json,code:{\n \name\: \New Support Email\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://new-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_processed_category\: \category_12345\\n }\n}\n}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e135632f56e02005fcbb1b2},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be `Email`.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d05bdd4f531001fbc67d1},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c0221ecfa670041e55c0d},{name:daktela,type:object,enumValues:,default:,desc:Contains Daktela-related configuration.,required:false,in:body,ref:,_id:5a1d322f61bdc2003611d6b7},{name:daktela.access_token,type:string,enumValues:,default:,desc:Access token of a Daktela user on whose behalf the actions are made.,required:false,in:body,ref:,_id:5dd2605e45075e0065e94919},{name:daktela.daktela_url,type:string,enumValues:,default:,desc:URL of Daktela instance.,required:false,in:body,ref:,_id:5dd2605e45075e0065e94918},{name:daktela.daktela_ticket_category,type:string,enumValues:,default:,desc:Used during handover to operator - the tickets category will be changed to this value.,required:false,in:body,ref:,_id:5e133e9e05d1a8019c3e60a0},{name:daktela.daktela_user_name,type:string,enumValues:,default:,desc:Optional. Used during handover to operator - the ticket will be assigned to this user.,required:false,in:body,ref:,_id:5e133e9e05d1a8019c3e609f},{name:daktela.daktela_queue,type:string,enumValues:,default:,desc:Name of queue in Daktela which this channel is connected to.,required:false,in:body,ref:,_id:646cb9c0e65360005e93218e},{name:daktela.daktela_processed_category,type:string,enumValues:,default:category_12345,desc:Optional. Only process email tickets that have this category set. If `daktela_processed_category`is null, process all emails. If `daktela_processed_category` is \NO_CATEGORY\, process only email tickets without a category.,required:false,in:body,ref:,_id:65e9e282d943820011db8e6a},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:email-daktela-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,previousSlug:email-channels-update-channel,mdx:{},isBodyEmpty:false,children:},{_id:5e1349c605d1a8019c3e61bd,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T07:07:30.441Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786}},results:{codes:{name:,code: ,language:json,status:204}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e1356432ba7c4001123eeb3},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:email-daktela-channels-delete-channel,type:endpoint,title:Delete Channel,deprecated:false,icon:,previousSlug:email-channels-delete-channel,isBodyEmpty:true,children:}},{_id:5e1353b438b739005680ebca,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T04:53:29.579Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:email-daktela-contacts,type:basic,title:Contacts,parentDoc:null,deprecated:false,icon:,previousSlug:email-contacts,isBodyEmpty:false,children:{_id:5e13551f020bd3004f3c726c,parentDoc:5e1353b438b739005680ebca,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T05:28:31.770Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{name:null,language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6619965168536114630\,\n \name\: \john@customer.com\\n }\n,name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e13551f020bd3004f3c726d},{name:max,type:int,enumValues:,default:,desc:Maximum number of contacts to retrieve.,required:false,in:query,ref:,_id:642bf47ae7b7f4004adc1e04},{name:offset,type:int,enumValues:,default:,desc:Offset of the retrieved contact list.,required:false,in:query,ref:,_id:642bf47ae7b7f4004adc1e03},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:email-daktela-contacts-list-contacts,type:endpoint,title:List Contacts,deprecated:false,icon:,previousSlug:email-contacts-list-contacts,isBodyEmpty:false,children:},{_id:5e1356b336a65202d530a001,parentDoc:5e1353b438b739005680ebca,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T13:10:50.375Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6619965168536114630}},results:{codes:{status:200,language:json,code:{\n \id\: \6619965168536114630\,\n \name\: \john@customer.com\\n},name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e1356b336a65202d530a003},{name:contact_id,type:string,enumValues:,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5e1356b336a65202d530a002},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:email-daktela-contacts-get-contact,type:endpoint,title:Get Contact,deprecated:false,icon:,previousSlug:email-contacts-get-contact,isBodyEmpty:false,children:},{_id:5e135784b1196a02ef0edd42,parentDoc:5e1353b438b739005680ebca,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T13:23:57.656Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339}},results:{codes:{status:204,language:json,code: ,name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e135784b1196a02ef0edd44},{name:contact_id,type:string,enumValues:,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5e135784b1196a02ef0edd43},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:email-daktela-contact-delete-contact,type:endpoint,title:Delete Contact,deprecated:false,icon:,previousSlug:email-contact-delete-contact,isBodyEmpty:true,children:}},{_id:5dc53e58d2bd610421b37ddc,createdAt:2019-11-08T10:07:20.508Z,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:email-daktela-webhooks,type:basic,title:Webhooks,parentDoc:null,deprecated:false,icon:,previousSlug:email-webhooks,isBodyEmpty:false,children:{_id:5dc53f2c7f77f00026cd18fb,createdAt:2019-11-08T10:10:52.968Z,parentDoc:5dc53e58d2bd610421b37ddc,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:email-daktela-message-received,type:basic,title:Message Received,deprecated:false,icon:,previousSlug:email-message-received,mdx:{},isBodyEmpty:false,children:}}},{_id:59fc42803cf718001069b926,from_sync:false,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,sync:{isSync:false,url:},slug:facebook-messenger-1,title:Facebook Messenger,__v:0,reference:true,createdAt:2016-12-10T11:25:06.059Z,order:5,pages:{_id:59fc42803cf718001069b939,hidden:false,link_url:,api:{auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{name:,status:400,language:json,code:{}}},settings:,url:},category:59fc42803cf718001069b926,createdAt:2016-12-19T10:10:54.551Z,title:Facebook Messenger,sync_unique:,type:basic,isReference:true,link_external:false,order:0,parentDoc:null,slug:api-facebook-messenger,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b936,hidden:false,parentDoc:null,createdAt:2016-12-10T11:26:50.710Z,link_url:,order:1,slug:facebook-messenger-messages,type:basic,api:{examples:{codes:{language:text,code:{\n \platform\: \facebook_messenger\,\n \recipient\: {\n \id\: \USER_ID\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hellow world!\\n },\n \Headers\: \\\n}}},method:get,params:,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},settings:,url:,auth:required},category:59fc42803cf718001069b926,title:Messages,isReference:true,link_external:false,sync_unique:,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:{_id:5a70712ac3cfa000542fbd50,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2018-01-30T13:20:42.788Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,examples:{codes:{code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages,language:curl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078996108088196\, \n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,name:}},auth:required,params:{_id:5a7071e1b3c9580024d1a2f5,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a7071e1b3c9580024d1a2f4,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:facebook-messenger-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b937,slug:facebook-messenger-messages-text,isReference:true,link_url:,hidden:false,category:59fc42803cf718001069b926,order:1,sync_unique:,type:endpoint,api:{examples:{codes:{name:JSON,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 640 characters.,default:,type:string,name:content.payload},{_id:598749c6720847000fea20e3,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a39a38e7e000128181a6,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:null,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},language:json,status:201}},settings:,url:/v1/messages,auth:required,apiSetting:5d8e9953589ec60039e75d81},link_external:false,parentDoc:59fc42803cf718001069b936,title:Text,createdAt:2016-12-10T11:27:03.188Z,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b943,type:endpoint,order:2,category:59fc42803cf718001069b926,createdAt:2016-12-21T12:15:48.727Z,isReference:true,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-image,sync_unique:,link_url:,title:Image,api:{auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:content.payload.url},{_id:59874a1e084150000f5194a5,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json,status:201}},settings:,url:/v1/messages,apiSetting:5d8e99f1ebdd2c006b877e28},hidden:false,link_external:false,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b947,link_url:,type:endpoint,sync_unique:,api:{url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \audio\,\n \payload\: {\n \url\: \http://dubioza.org/site/wp-content/uploads/2016/02/1.-All-Equal-feat-BEE2.mp3\\n }\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `audio`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the audio to be sent. Max size is 25 MB.,default:,type:string,name:content.payload.url},{_id:59874a4b743049000f350017,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3cd28bd9b0012b3da21,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \audio\,\n \payload\: {\n \url\: \http://dubioza.org/site/wp-content/uploads/2016/02/1.-All-Equal-feat-BEE2.mp3\\n }\n }\n},language:json,status:201}},settings:,apiSetting:5d8e9a98c4c04c00696b57ca},isReference:true,link_external:false,slug:facebook-messenger-messages-audio,title:Audio,category:59fc42803cf718001069b926,createdAt:2016-12-22T08:38:04.366Z,hidden:false,order:3,parentDoc:59fc42803cf718001069b936,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b948,api:{method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `video`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the video to be sent. Max size is 25 MB.,default:,type:string,name:content.payload.url},{_id:59874a6ac66549000f043b40,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3d6f7b5a0001e036bf6,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},name:}},settings:,url:/v1/messages,auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},language:json}},apiSetting:5d8e9b7719f4740011d43b89},hidden:false,parentDoc:59fc42803cf718001069b936,sync_unique:,type:endpoint,category:59fc42803cf718001069b926,link_external:false,createdAt:2016-12-22T08:42:42.861Z,isReference:true,link_url:,order:4,slug:facebook-messenger-messages-video,title:Video,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b949,sync_unique:,type:endpoint,category:59fc42803cf718001069b926,link_url:,link_external:false,order:5,createdAt:2016-12-22T08:43:08.506Z,isReference:true,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-file,title:File,api:{method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `file`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the file to be sent. Max size is 25 MB.,default:,type:string,name:content.payload.url},{_id:59874a8c564140000f53e5a5,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3e0f7b5a0001e036bf8,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \http://example.com/pdf.pdf\\n }\n }\n},language:json,status:201}},settings:,url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \http://example.com/pdf.pdf\\n }\n }\n}}},apiSetting:5d8e9bc3f4e44300312dd1b7},hidden:false,isBodyEmpty:false,children:},{_id:5a33d15e7698a1001ca9855e,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2017-12-15T13:42:54.514Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:6,slug:facebook-messenger-messages-location,type:basic,title:Location,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b94e,link_url:,order:7,sync_unique:,createdAt:2017-01-02T15:22:11.178Z,hidden:false,link_external:false,api:{settings:,url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \receipt\,\n \payload\: {\n \order_id\: \id546584\, \n \timestamp\: \2016-10-06T13:42:48Z\,\n \currency\: \USD\,\n \payment_method\: \Visa ***8138.\,\n \url_order\: \http://petersapparel.parseapp.com/order?order_idid546584\,\n \shipping_address\: {\n \name\: \Tomáš Baťa\,\n \address_line_1\: \tř. Tomáše Bati 46\,\n \address_line_2\: \company Bata a.s.\,\n \city\: \Otrokovice\,\n \postal_code\: \765 02\,\n \state\: \Zlín Region\,\n \country_code\: \CZ\\n },\n \items\: \n {\n \title\:\Winter Mens Footware\,\n \text\:\100% Leather\,\n \quantity\:1,\n \price\:67.5,\n \image_url\:\http://3-cz-cdn.bata.eu/gallery/1/6/4/5/7/c.jpg\\n }\n ,\n \summary\: {\n \shipping\: 4.95,\n \tax\: 6.19,\n \total\: 78.64\n }\n }\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `receipt`.,default:,type:string,name:content.type},{_id:586c01f75acc511b00c38681,ref:,in:body,required:true,desc:Order id. Has to be unique for each recepient.,default:,type:string,name:payload.order_id},{_id:586bff410abf1d0f000d04d2,ref:,in:body,required:false,desc:Timestamp of the order. Must be in ISO 8601(https://en.wikipedia.org/wiki/ISO_8601) timestamp form, e.g. *2016-10-06T13:42:48Z*. This timestamp is zone agnostic it means that if you use zone in your format, the time will be shifted to UTC.,default:,type:datetime,name:payload.timestamp},{_id:586c009c50fe5a0f004ab7b0,ref:,in:body,required:true,desc:Currency in the form of ISO 4217(https://en.wikipedia.org/wiki/ISO_4217), e.g. *USD* or *CZK*.,default:,type:string,name:payload.currency},{_id:586c01f75acc511b00c38682,ref:,in:body,required:false,desc:URL with order details.,default:,type:string,name:payload.url_order},{_id:586c04e550fe5a0f004ab7b8,ref:,in:body,required:true,desc:Payment method. This can be a custom string, e.g. *Visa 1234*.,default:,type:string,name:payload.payment_method},{_id:586c04e550fe5a0f004ab7b7,ref:,in:body,required:true,desc:Recipients full name. Required if address is set.,default:,type:string,name:shipping_address.name},{_id:586ab7389698b91900f84938,ref:,in:body,required:false,desc:Address line 1, P.O. box, company name, c/o. Required if city is set.,default:,type:string,name:shipping_address.address_line_1},{_id:586ab7a57f27f439005b5760,ref:,in:body,required:false,desc:Apartment, suite, unit, building, floor, etc.,default:,type:string,name:shipping_address.address_line_2},{_id:587362ae1ddb870f008bad48,ref:,in:body,required:false,desc:City. Required if address is set. Required if address_line_1is set.,default:,type:string,name:shipping_address.city},{_id:586ab7a57f27f439005b575f,ref:,in:body,required:false,desc:Postal Code. Required if address is set. Required if address_line_1is set.,default:,type:string,name:shipping_address.postal_code},{_id:586c05d5cb4ea827001fd11f,ref:,in:body,required:false,desc:State abbreviation or Region/Province (international). Required if address_line_1is set.,default:,type:string,name:shipping_address.state},{_id:586c05d5cb4ea827001fd11e,ref:,in:body,required:false,desc:Country code according to ISO 3166 - alpha2(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Required if address_line_1is set.,default:,type:string,name:shipping_address.country_code},{_id:586e6951e894522f003aea44,ref:,in:body,required:false,desc:Item title. Required if item is set.,default:,type:string,name:items.title},{_id:586e6951e894522f003aea43,ref:,in:body,required:false,desc:Item subtitle.,default:,type:string,name:items.text},{_id:586e6951e894522f003aea42,ref:,in:body,required:false,desc:Quantity of items.,default:,type:int,name:items.quantity},{_id:586e6951e894522f003aea41,ref:,in:body,required:false,desc:Price of the item. 0 is allowed. Required if item is set.,default:,type:double,name:items.price},{_id:586e6951e894522f003aea40,ref:,in:body,required:false,desc:Url of the item image.,default:,type:string,name:items.image_url},{_id:586e6951e894522f003aea3f,ref:,in:body,required:false,desc:Cost of shipping.,default:,type:double,name:summary.shipping},{_id:586e6951e894522f003aea3e,ref:,in:body,required:false,desc:Total tax.,default:,type:double,name:summary.tax},{_id:586e6951e894522f003aea3d,ref:,in:body,required:true,desc:Total cost.,default:,type:double,name:summary.total},{_id:59874adc084150000f5194a6,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3ec9610050012c4a2d6,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \receipt\,\n \payload\: {\n \order_id\: \id546584\, \n \timestamp\: \2016-10-06T13:42:48Z\,\n \currency\: \USD\,\n \payment_method\: \Visa ***8138.\,\n \url_order\: \http://petersapparel.parseapp.com/order?order_idid546584\,\n \shipping_address\: {\n \name\: \Tomáš Baťa\,\n \address_line_1\: \tř. Tomáče Bati 46\,\n \address_line_2\: \company Bata a.s.\,\n \city\: \Otrokovice\,\n \postal_code\: \765 02\,\n \country_code\: \CZ\\n },\n \items\: \n {\n \title\:\Winter Mens Footware\,\n \text\:\100% Leather\,\n \quantity\:1,\n \price\:67.5,\n \image_url\:\http://3-cz-cdn.bata.eu/gallery/1/6/4/5/7/c.jpg\\n }\n ,\n \summary\: {\n \shipping\: 4.95,\n \tax\: 6.19,\n \total\: 78.64\n }\n }\n }\n},language:json,status:201}},apiSetting:5d8e9c39f4e44300312dd1c7},category:59fc42803cf718001069b926,title:Receipt,type:endpoint,isReference:true,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-receipt,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b94a,api:{results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},settings:,url:/v1/messages,auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},method:post,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:payload.title,type:string,enumValues:,default:,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`. You can also omit the title attribute and use only `text` and `buttons` attributes.,required:false,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:payload.text,type:string,enumValues:,default:,desc:Message text. **Max size** 80 characters. However, you can use **up to 640 characters** if you use` text` with `buttons` only.,required:false,in:body,ref:,_id:585b96556399952d00e0ac38},{name:payload.image_url,type:string,enumValues:,default:,desc:Url of an image to be displayed. Image ratio is 1.91:1.,required:false,in:body,ref:,_id:585b96556399952d00e0ac37},{name:payload.item_url,type:string,enumValues:,default:,desc:Url which is opened when the message is tapped.,required:false,in:body,ref:,_id:585b96556399952d00e0ac36},{name:payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:false,in:body,ref:,_id:585b96556399952d00e0ac35},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a58e527791cac001c857652},apiSetting:5d8e9cdeebdd2c006b877e50},category:59fc42803cf718001069b926,link_external:false,title:Structure,link_url:,sync_unique:,type:endpoint,createdAt:2016-12-22T08:44:33.901Z,isReference:true,order:8,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-structure,hidden:false,previousSlug:,deprecated:false,icon:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b94b,hidden:false,isReference:true,link_url:,type:endpoint,link_external:false,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-structure-horizontal-scroll,api:{auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger with Coleslaw salad\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `structure`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`.,default:,type:string,name:payload.title},{_id:585b96556399952d00e0ac38,ref:,in:body,required:false,desc:Message text. **Max size** 80 characters.,default:,type:string,name:payload.text},{_id:585b96556399952d00e0ac37,ref:,in:body,required:false,desc:Url of an image to be displayed. Image ratio is 1.91:1.,default:,type:string,name:payload.image_url},{_id:585b96556399952d00e0ac36,ref:,in:body,required:false,desc:Url which is opened when the message is tapped.,default:,type:string,name:payload.item_url},{_id:585b96556399952d00e0ac35,ref:,in:body,required:false,desc:Buttons to be shown below the message. Limetted to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,default:,type:array_object,name:payload.buttons},{_id:5a16a40228bd9b0012b3da22,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger with Coleslaw salad\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n}}},settings:,url:/v1/messages,apiSetting:5d8e9ea50f3b8a002575a34b},category:59fc42803cf718001069b926,createdAt:2016-12-22T10:31:14.466Z,order:9,sync_unique:,title:Structure - Horizontal Scroll,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b950,link_url:,createdAt:2017-01-06T13:31:36.252Z,isReference:true,slug:facebook-messenger-messages-buttons,category:59fc42803cf718001069b926,title:Buttons,type:basic,link_external:false,order:10,hidden:false,parentDoc:59fc42803cf718001069b936,sync_unique:,api:{results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,examples:{codes:},method:get,params:},deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b9a2,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2017-08-06T10:23:42.785Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:},settings:,results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:11,slug:facebook-messenger-messages-quick-replies,type:basic,title:Quick Replies,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a16a20928bd9b0012b3d9b4,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2017-11-23T10:25:13.563Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:12,slug:facebook-messenger-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:},{_id:5ae725e3ea73080003370581,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2018-04-30T14:19:15.475Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:13,slug:facebook-messenger-messages-types,type:basic,title:Types,isBodyEmpty:false,children:},{_id:5a27c3abffe263002650fec7,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2017-12-06T10:17:15.060Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:14,slug:facebook-messenger-messages-tags,type:basic,title:Tags,isBodyEmpty:false,children:}},{_id:5a14130a05c0b0001e507e06,category:59fc42803cf718001069b926,createdAt:2017-11-21T11:50:34.165Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:facebook-messenger-notifications,type:basic,title:Notifications,parentDoc:null,isBodyEmpty:false,children:{_id:5a141584f96ca1003caf7f80,category:59fc42803cf718001069b926,parentDoc:5a14130a05c0b0001e507e06,createdAt:2017-11-21T12:01:08.455Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,settings:,results:{codes:{name:,code:{\n \channel\: {\n \id\: \6456078759331238786\,\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \type\: \typing_on\\n},language:json,status:200}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \type\: \typing_on\\n},language:json}},auth:required,params:{_id:586a5a05e272d81900733a6c,ref:,in:body,required:true,desc:Id of the channel you wish to send the notification to. You can get channel id in administration.,default:,type:string,name:channel.id},{_id:58d271a5eb285919003337c1,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:5a141672e6f0d3001eeceaee,ref:,in:body,required:true,desc:Type specifies the notification to be sent and can have following values: \u003cbr />- `messages_read` - shows that all received messages from contact are read \u003cbr />- `typing_on` - shows the typing indicator \u003cbr />- `typing_off` - hides the typing indicator - if you dont switch off the typing indicator, it is switched off automatically (typically in 20 seconds).,default:,type:string,name:type},url:/v1/notifications,method:post},isReference:true,order:0,slug:facebook-messenger-notifications-send-notification,type:endpoint,title:Send Notification,isBodyEmpty:false,children:}},{_id:5a1d20a4370eeb002af86fb0,category:59fc42803cf718001069b926,createdAt:2017-11-28T08:39:00.180Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:facebook-messenger-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5a1d213b67d310001245bd1c,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T08:41:31.323Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},results:{codes:{name:OK,code:\n {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \name\: \Amio\,\n \category\: \Internet Company\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n }\n,language:json,status:200}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:facebook-messenger-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d279867d310001245bdd0,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T09:08:40.005Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \name\: \Amio\,\n \category\: \Internet Company\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n},language:json,status:200}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},auth:required,params:,url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:facebook-messenger-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d284a9d3741002afd4524,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T09:11:38.412Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \type\: \facebook_messenger\,\n \name\: \Amio Channel\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n},language:json}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\,\n \name\: \Amio Channel\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \name\: \Amio\,\n \category\: \Internet Company\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n},language:json,status:201}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `facebook_messenger`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be filled with connected Facebook Page name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d05bdd4f531001fbc67d1},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c025c68b40d005007381a},{name:facebook_page.id,type:string,enumValues:,default:,desc:Id of the facebook page to be connected.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b7},{name:facebook_page.access_token,type:string,enumValues:,default:,desc:Access token to be used for Facebook API calls. This can be any type of access token with required permission. Typically, you will send User Access Token obtained after successful Facebook OAuth login procedure. When you create a channel, we request for long lived Page Access Token what ensures that the access token wont expire. See Facebook documentation(https://developers.facebook.com/docs/facebook-login/access-tokens) for more details.\u003cbr />\u003cbr />You can only use access tokens that were generated for a certain Facebook App. If you want to use your own Facebook App, let us know at support@amio.io(mailto:support@amio.io). This SO(https://stackoverflow.com/questions/52053140/cannot-create-a-channel-via-api-in-amio-io/52071941#52071941) answer explains how to generate `access_token` for a given Facebook Application.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b4},url:/v1/channels,method:post},isReference:true,order:2,slug:facebook-messenger-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d3f7267d310001245bffb,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T10:50:26.065Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \name\: \Amio\,\n \category\: \Internet Company\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n},language:json,status:200}},examples:{codes:{language:json,code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \facebook_page\: {\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n}}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d3fd59d3741002afd488d},{name:name,type:string,enumValues:,default:,desc:Name of the channel. Might be an arbitrary name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d05ff173c120053dc6657},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:facebook_page.access_token,type:string,enumValues:,default:,desc:Access token to be used for Facebook API calls. This can be any type of access token with required permission. Typically, you will send User Access Token obtained after successful Facebook OAuth login procedure. When you create a channel, we request for long lived Page Access Token what ensures that the access token wont expire. See Facebook documentation(https://developers.facebook.com/docs/facebook-login/access-tokens) for more details.\u003cbr />\u003cbr />You can only use access tokens that were generated for a certain Facebook App. If you want to use your own Facebook App, let us know at support@amio.io(mailto:support@amio.io). This SO(https://stackoverflow.com/questions/52053140/cannot-create-a-channel-via-api-in-amio-io/52071941#52071941) answer explains how to generate `access_token` for a given Facebook Application.,required:false,in:body,ref:,_id:5cdbf59ce607e5000ebde527},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c028a6b04ee0270f29a7f},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:facebook-messenger-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d409fd31946001cc1309c,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T10:55:27.047Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:facebook-messenger-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5a131534b57953001cece0e4,category:59fc42803cf718001069b926,createdAt:2017-11-20T17:47:32.693Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:facebook-messenger-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5a13159845769d002674f1ca,category:59fc42803cf718001069b926,parentDoc:5a131534b57953001cece0e4,createdAt:2017-11-20T17:49:12.929Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\,\n \gender\: \male\,\n \locale\: \de_DE\,\n \time_zone\: \+02:00\,\n \photo_url\: \https://storage.amio.io/profile/6456078781510718339/avatar\\n }\n,name:OK}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:facebook-messenger-contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5a1315c2b57953001cece0e8,category:59fc42803cf718001069b926,parentDoc:5a131534b57953001cece0e4,createdAt:2017-11-20T17:49:54.645Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,results:{codes:{name:OK,code:{\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \user_ref\: \123456789\,\n \name\: \Dietrich Bonhoeffer\,\n \gender\: \male\,\n \locale\: \de_DE\,\n \time_zone\: \+02:00\,\n \photo_url\: \https://storage.amio.io/profile/6456078781510718339/avatar\\n },language:json,status:200}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:facebook-messenger-contacts-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5a1315ccddc95100120c4a0b,category:59fc42803cf718001069b926,parentDoc:5a131534b57953001cece0e4,createdAt:2017-11-20T17:50:04.060Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:facebook-messenger-contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:59fc42803cf718001069b97b,api:{results:{codes:{status:200,language:json,code:{},name:},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},slug:facebook-messenger-settings,category:59fc42803cf718001069b926,hidden:false,link_url:,parentDoc:null,title:Settings,type:basic,link_external:false,createdAt:2017-05-01T08:48:58.812Z,isReference:true,order:5,sync_unique:,isBodyEmpty:false,children:{_id:5a142be1d93a490028dc7c7d,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b97b,createdAt:2017-11-21T13:36:33.034Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,results:{codes:{status:200,language:json,code:{\n \get_started_button\: {\n \payload\: \{{GET_STARTED_PAYLOAD}}\\n },\n \menu\: \n {\n \locale\: \default\,\n \items\: \n {\n \type\: \url\,\n \title\: \URL Item\,\n \payload\: \http://www.google.com\\n }\n \n }\n ,\n \user_inputs\: \n {\n \locale\: \default\,\n \enabled\: true\n }\n ,\n \domains_whitelist\: \n \https://app.amio.io\\n \n},name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/settings,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:get},isReference:true,order:0,slug:facebook-messenger-settings-get-settings,type:endpoint,title:Get Settings,isBodyEmpty:false,children:},{_id:5c63e6ce72efad0126555b1f,createdAt:2019-02-13T09:43:42.958Z,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b97b,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:{\n \get_started_button\: {\n \payload\: \{{GET_STARTED_PAYLOAD}}\\n },\n \menu\: \n {\n \locale\: \default\,\n \items\: \n {\n \type\: \url\,\n \title\: \URL Item\,\n \payload\: \http://www.google.com\\n }\n \n }\n ,\n \user_inputs\: \n {\n \locale\: \default\,\n \enabled\: true\n }\n ,\n \domains_whitelist\: \n \https://app.amio.io\\n \n},language:json}},results:{codes:{status:200,language:json,code:{\n \get_started_button\: {\n \payload\: \{{GET_STARTED_PAYLOAD}}\\n },\n \menu\: \n {\n \locale\: \default\,\n \items\: \n {\n \type\: \url\,\n \title\: \URL Item\,\n \payload\: \http://www.google.com\\n }\n \n }\n ,\n \user_inputs\: \n {\n \locale\: \default\,\n \enabled\: true\n }\n ,\n \domains_whitelist\: \n \https://app.amio.io\\n \n},name:OK}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:patch},isReference:true,order:1,slug:facebook-messenger-settings-update-settings,type:endpoint,title:Update Settings,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b98b,slug:facebook-messeger-settings-get-started-button,title:Get Started Button,hidden:false,isReference:true,link_url:,type:basic,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},order:2,parentDoc:59fc42803cf718001069b97b,sync_unique:,createdAt:2017-05-19T12:14:37.657Z,link_external:false,category:59fc42803cf718001069b926,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b97c,api:{method:post,params:,results:{codes:{status:201,language:json,code:{}\t,name:}},url:/v1/channels/{channel_id}/menus,auth:required,examples:{codes:{code:{\n \payload\: {\n \menu_items\: \n {\n \type\: \url\,\n \title\: \URL Menu\,\n \payload\: \http://www.google.com\\n },\n {\n \type\: \postback\,\n \title\: \POSTBACK Menu\,\n \payload\: \POSTBACK DATA\\n },\n {\n \type\: \menu\,\n \title\: \NESTED Menu\,\n \payload\: {\n \menu_items\: \n {\n \type\: \url\,\n \title\: \NESTED URL Menu\,\n \payload\: \http://www.google.com\\n },\n {\n \type\: \postback\,\n \title\: \NESTED POSTBACK Menu\,\n \payload\: \POSTBACK DATA\\n }\n \n }\n }\n \n }\n}\t,language:json}}},isReference:true,parentDoc:59fc42803cf718001069b97b,slug:facebook-messeger-settings-menu,title:Menu,category:59fc42803cf718001069b926,createdAt:2017-05-01T08:49:25.359Z,hidden:false,link_url:,order:3,sync_unique:,link_external:false,type:basic,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b98e,category:59fc42803cf718001069b926,order:4,parentDoc:59fc42803cf718001069b97b,sync_unique:,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},createdAt:2017-05-22T12:26:31.880Z,slug:facebook-messeger-settings-user-inputs,hidden:false,link_external:false,link_url:,title:User Inputs,isReference:true,type:basic,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b99e,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b97b,createdAt:2017-07-04T16:00:41.178Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:facebook-messeger-settings-domains-whitelist,type:basic,title:Domains Whitelist,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b93a,link_url:,slug:facebook-messenger-webhooks,title:Webhooks,isReference:true,order:6,parentDoc:null,api:{settings:,url:,auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}}},category:59fc42803cf718001069b926,sync_unique:,type:basic,createdAt:2016-12-19T16:35:33.469Z,hidden:false,link_external:false,isBodyEmpty:false,children:{_id:59fc42803cf718001069b945,sync_unique:,title:Message Received,hidden:false,isReference:true,link_url:,api:{auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:,examples:{codes:}},link_external:false,order:0,type:basic,category:59fc42803cf718001069b926,createdAt:2016-12-21T14:21:29.521Z,parentDoc:59fc42803cf718001069b93a,slug:facebook-messenger-webhooks-message-received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc508977dc0a0010000d78,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b93a,createdAt:2017-11-03T11:18:33.020Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:1,slug:facebook-messenger-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:59fc4fea77dc0a0010000d70,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b93a,createdAt:2017-11-03T11:15:54.106Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:facebook-messenger-webhooks-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b956,link_external:false,order:3,createdAt:2017-03-06T19:29:34.650Z,link_url:,type:basic,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,parentDoc:59fc42803cf718001069b93a,sync_unique:,title:Message Echo,category:59fc42803cf718001069b926,slug:facebook-messeger-webhooks-message-echo,hidden:false,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b954,category:59fc42803cf718001069b926,sync_unique:,hidden:false,link_url:,order:4,link_external:false,title:Postback Received,createdAt:2017-03-01T20:48:21.762Z,parentDoc:59fc42803cf718001069b93a,slug:facebook-messeger-webhooks-postback-received,type:basic,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b946,link_url:,title:Opt-in,slug:facebook-messeger-webhooks-opt-in,type:basic,api:{auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:},createdAt:2016-12-21T14:22:41.198Z,link_external:false,parentDoc:59fc42803cf718001069b93a,category:59fc42803cf718001069b926,hidden:false,order:5,sync_unique:,isReference:true,isBodyEmpty:false,children:}}},{_id:59fc42803cf718001069b927,__v:0,from_sync:false,order:6,project:584bd29609104d23007d9ec9,reference:true,slug:sms-1,createdAt:2016-12-10T11:25:16.080Z,sync:{url:,isSync:false},title:Mobile,version:59fc42803cf718001069b9ab,pages:{_id:59fc42803cf718001069b951,category:59fc42803cf718001069b927,createdAt:2017-01-07T10:48:18.254Z,link_external:false,parentDoc:null,slug:api-mobile,sync_unique:,hidden:false,link_url:,order:0,isReference:true,title:Mobile,api:{params:,results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,method:get},type:basic,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b952,createdAt:2017-01-07T14:37:29.298Z,link_url:,slug:mobile-messages,isReference:true,link_external:false,sync_unique:,type:basic,title:Messages,api:{auth:required,method:get,params:,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},settings:,url:},category:59fc42803cf718001069b927,hidden:false,order:1,parentDoc:null,isBodyEmpty:false,children:{_id:5b0ec6af748b2c0003ee3910,category:59fc42803cf718001069b927,parentDoc:59fc42803cf718001069b952,createdAt:2018-05-30T15:43:43.786Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \mobile\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,name:},{status:400,language:json,code:{},name:}},auth:required,params:{_id:5b0ec704748b2c0003ee3d0a,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5b0ec704748b2c0003ee3d09,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get,apiSetting:5d8abde8192ec60031349232,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}}},isReference:true,order:0,slug:mobile-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:true,children:},{_id:59fc42803cf718001069b953,link_external:false,sync_unique:,isReference:true,slug:mobile-messages-text,category:59fc42803cf718001069b927,hidden:false,order:1,title:Text,type:endpoint,api:{examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1 (555) 857-6309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Phone number of the contact. All phone number formats are accepted. \u003cbr />\u003cbr />⚠ You always need to include international call prefix(https://en.wikipedia.org/wiki/List_of_international_call_prefixes).,default:,type:string,name:contact. phone_number},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum length of text depends on provider (MessageBird(https://support.messagebird.com/hc/en-us/articles/208739745-How-long-is-1-SMS-Message-) - 1377 characters).,default:,type:string,name:content.payload},results:{codes:{name:,status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \mobile\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},settings:,url:/v1/messages,auth:required,apiSetting:5d8abde8192ec60031349232},createdAt:2017-01-07T14:37:53.801Z,link_url:,parentDoc:59fc42803cf718001069b952,isBodyEmpty:false,children:},{_id:5b0fe1e571063b00037123fa,category:59fc42803cf718001069b927,parentDoc:59fc42803cf718001069b952,createdAt:2018-05-31T11:52:05.482Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:mobile-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:}},{_id:5b0fc3b371063b00037121d5,category:59fc42803cf718001069b927,createdAt:2018-05-31T09:43:15.521Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:mobile-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5b0fc3df3ebcea000311e5e1,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T09:43:59.223Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078759331238786\,\n \type\: \mobile\,\n \name\: \Amio Mobile\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\,\n \status_webhook_url\: \https://api.amio.io/webhook/messagebird/status/152775927128158\,\n \receive_webhook_url\: \https://api.amio.io/webhook/messagebird/message/6204630442/152811200579929\\n }\n }\n,name:OK}},apiSetting:5d8abde8192ec60031349232,auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:mobile-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b0fc8c43ebcea000311e682,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T10:04:52.391Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abde8192ec60031349232,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \mobile\,\n \name\: \Amio Mobile\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\,\n \status_webhook_url\: \https://api.amio.io/webhook/messagebird/status/152775927128158\,\n \receive_webhook_url\: \https://api.amio.io/webhook/messagebird/message/6204630442/152811200579929\\n }\n},language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d6a419d3741002afd4d9a},url:/v1/channels/{chanel_id},method:get},isReference:true,order:1,slug:mobile-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b0fca12572fa80003e5036b,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T10:10:26.864Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \type\: \mobile\,\n \name\: \Amio Mobile\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\\n }\n}}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \mobile\,\n \name\: \Amio Mobile\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\,\n \status_webhook_url\: \https://api.amio.io/webhook/messagebird/status/152776172104684\,\n \receive_webhook_url\: \https://api.amio.io/webhook/messagebird/message/6204630442/152811200579929\\n }\n},language:json,status:201}},apiSetting:5d8abde8192ec60031349232,auth:required,params:{_id:5a1c4077f512d400124699bb,ref:,in:body,required:true,desc:Channel type, `mobile`.,default:,type:string,name:type},{_id:5a1c459dacac6b001e666b52,ref:,in:body,required:false,desc:Name of the channel. If not set, it will be auto-generated.,default:,type:string,name:name},{_id:5d5d078c13c5490225e6a865,ref:,in:body,required:false,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:mobile-messages-text) requests will be accepted and sent as SMS. `test` - Send Message(ref:mobile-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message as SMS.,default:,type:string,name:mode},{_id:5a1c40a1c73b44001ed59949,ref:,in:body,required:false,desc:Webhook url where all channel events would be sent to.,default:,type:string,name:webhook.url},{_id:5e3c036291788a005bf228fa,ref:,in:body,required:false,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,default:,type:string,name:webhook.secret},{_id:5a1d322f61bdc2003611d6b5,ref:,in:body,required:true,desc:Name of the service provider. Following values are allowed: `messagebird`.,default:,type:string,name:provider.type},{_id:5b0fcc2c71063b000371228b,ref:,in:body,required:true,desc:Access token used for authorising requests to provider.,default:,type:string,name:provider.access_token},{_id:5b98c771305be800034e5306,ref:,in:body,required:true,desc:Signature key used for verifying that incoming webhook came from MessageBird. You can get this key in MessageBird administration(https://dashboard.messagebird.com/developers/settings).,default:,type:string,name:provider.signing_key},{_id:5b0fcc2c71063b000371228a,ref:,in:body,required:true,desc:Phone number registered at the provider or custom sender ID to be used as a message originator.,default:,type:string,name:provider.sender_id},url:/v1/channels,method:post},isReference:true,order:2,slug:mobile-channels-create-channel,type:endpoint,title:Create Channel,isBodyEmpty:false,children:},{_id:5b0fcd13c4e0380003372984,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T10:23:15.465Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abde8192ec60031349232,results:{codes:{status:200,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \mobile\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\,\n \status_webhook_url\: \https://api.amio.io/webhook/messagebird/status/152775927128158\,\n \receive_webhook_url\: \https://api.amio.io/webhook/messagebird/message/6204630442/152811200579929\\n }\n},name:OK}},examples:{codes:{code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \provider\: {\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\\n }\n},language:json}},auth:required,params:{_id:5a1d70ca721b9a0026bbd418,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a1c459dacac6b001e666b52,ref:,in:body,required:false,desc:Name of the channel. Might be an arbitrary name.,default:,type:string,name:name},{_id:5d5d07cffe803c006f399c3e,ref:,in:body,required:false,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:mobile-messages-text) requests will be accepted and sent as SMS. `test` - Send Message(ref:mobile-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message as SMS.,default:,type:string,name:mode},{_id:5a1c40a1c73b44001ed59949,ref:,in:body,required:false,desc:Webhook url where all channel events would be sent to.,default:,type:string,name:webhook.url},{_id:5b28cbcff11cd000039ca3f2,ref:,in:body,required:false,desc:Access token used for authorising requests to provider.,default:,type:string,name:provider.access_token},{_id:5b98c80e305be800034e5314,ref:,in:body,required:false,desc:Signature key used for verifying that incoming webhook came from MessageBird. You can get this key in MessageBird administration(https://dashboard.messagebird.com/developers/settings).,default:,type:string,name:provider.signing_key},{_id:5b28cbcff11cd000039ca3f1,ref:,in:body,required:false,desc:Phone number registered at the provider or custom sender ID to be used as a message originator.,default:,type:string,name:provider.sender_id},{_id:5e3c03a38171ea0059a7d1dc,ref:,in:body,required:false,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,default:,type:string,name:webhook.secret},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:mobile-channels-update-channel,type:endpoint,title:Update Channel,isBodyEmpty:false,children:},{_id:5b0fce6b71063b00037122b1,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T10:28:59.778Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abde8192ec60031349232,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:mobile-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5b0fe338c4e0380003372b57,category:59fc42803cf718001069b927,createdAt:2018-05-31T11:57:44.013Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:mobile-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5b0fe3a9c4e0380003372b64,category:59fc42803cf718001069b927,parentDoc:5b0fe338c4e0380003372b57,createdAt:2018-05-31T11:59:37.603Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n }\n,name:OK}},apiSetting:5d8abde8192ec60031349232,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:mobile-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5b0fe5797d6ce90003071867,category:59fc42803cf718001069b927,parentDoc:5b0fe338c4e0380003372b57,createdAt:2018-05-31T12:07:21.492Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abde8192ec60031349232,results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n},name:OK}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:mobile-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5b0fe77c4b213d0003828e80,category:59fc42803cf718001069b927,parentDoc:5b0fe338c4e0380003372b57,createdAt:2018-05-31T12:15:56.251Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},apiSetting:5d8abde8192ec60031349232,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:mobile-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5b0ffd483ebcea000311eb38,category:59fc42803cf718001069b927,createdAt:2018-05-31T13:48:56.176Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:mobile-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5b471bd23dcb6a0003c6e9ac,category:59fc42803cf718001069b927,parentDoc:5b0ffd483ebcea000311eb38,createdAt:2018-07-12T09:13:54.108Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:mobile-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b0ffe0dc4e0380003372f58,category:59fc42803cf718001069b927,parentDoc:5b0ffd483ebcea000311eb38,createdAt:2018-05-31T13:52:13.291Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:mobile-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5ab4b65e187309001fe90732,category:59fc42803cf718001069b927,parentDoc:5b0ffd483ebcea000311eb38,createdAt:2018-03-23T08:10:06.331Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:mobile-webhooks-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:5b8d4e875a46ee000379283f,category:59fc42803cf718001069b927,parentDoc:5b0ffd483ebcea000311eb38,createdAt:2018-09-03T15:08:55.677Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:3,slug:mobile-message-echo,type:basic,title:Message Echo,isBodyEmpty:false,children:}}},{_id:5d5bf6b77913cf004e75718a,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2019-08-20T13:33:43.759Z,order:7,slug:rcs-business-messages-1,title:RCS Business Messages,__v:0,pages:{_id:5d5bf70c33015d003ba0fb9e,createdAt:2019-08-20T13:35:08.981Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-rbm,type:basic,title:RCS Business Messages,parentDoc:null,isBodyEmpty:false,children:},{_id:5d5bf7e2b60f6d0034540e81,createdAt:2019-08-20T13:38:42.157Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:rbm-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5d5bfc48cac552002aefd441,createdAt:2019-08-20T13:57:28.762Z,category:5d5bf6b77913cf004e75718a,parentDoc:5d5bf7e2b60f6d0034540e81,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \rbm\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,name:},{status:400,language:json,code:{},name:}},auth:required,params:{_id:5d5bfc48cac552002aefd443,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5d5bfc48cac552002aefd442,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:list-messages,type:endpoint,title:List Messages,isBodyEmpty:true,children:},{_id:5d5bf9161298cf015487983c,createdAt:2019-08-20T13:43:50.964Z,category:5d5bf6b77913cf004e75718a,parentDoc:5d5bf7e2b60f6d0034540e81,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \rbm\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},language:json,status:201}},auth:required,params:{_id:5d5bfbd7f20ff50052c03ae8,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5d5bfbd7f20ff50052c03ae7,ref:,in:body,required:true,desc:Phone number of the contact. All phone number formats are accepted. \u003cbr />\u003cbr />⚠ You always need to include international call prefix(https://en.wikipedia.org/wiki/List_of_international_call_prefixes).,default:,type:string,name:contact. phone_number},{_id:5d5bfbd7f20ff50052c03ae6,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:5d5bfbd7f20ff50052c03ae5,ref:,in:body,required:true,desc:Text to be sent encoded in UTF-8. The maximum size of a message is 250 KB.,default:,type:string,name:content.payload},url:/v1/messages,method:post,apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1 (555) 857-6309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}}},isReference:true,order:1,slug:rbm-messages-text,type:endpoint,title:Text,isBodyEmpty:false,children:},{_id:65bb5ff28ae912000f35c824,api:{method:post,url:/v1/messages/,auth:required,results:{codes:{name:,code:{},language:json,status:201},{name:,code:{},language:json,status:400}},params:{name:channel.id,type:string,enumValues:,default:,desc:id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33529},{name:contact.phone_number,type:string,enumValues:,default:,desc:Phone number of the contact. All phone number formats are accepted. \u003cbr />\u003cbr />⚠ You always need to include international call prefix(https://en.wikipedia.org/wiki/List_of_international_call_prefixes).,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33528},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33527},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. *Max size* 80 characters. However, you can use *up to 640 characters* if you use` text` with `buttons` only.,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33526},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33525},examples:{codes:{code:{\n \channel\: {\n \id\: \{{amio_chat.channel.id}}\\n },\n \contact\: {\n \id\: \{{amio_chat.contact.id}}\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \text\: \For more info:\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Visit our website\,\n \payload\: \https://amio.io\\n },\n {\n \type\: \postback\,\n \title\: \About us\,\n \payload\: \postbackpayload\\n },\n {\n \type\: \phone\,\n \title\: \Call us\,\n \payload\: \+123456789\\n }\n \n }\n }\n},language:json}},apiSetting:5d8abe2605260200d46221ab},title:Structure,icon:,type:endpoint,slug:rbm-messages-structure,order:2,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:structure-copy,parentDoc:5d5bf7e2b60f6d0034540e81,category:5d5bf6b77913cf004e75718a,createdAt:2024-02-01T09:10:10.354Z,isBodyEmpty:true,children:}},{_id:5d5bfc6cd1b5f1026fdff395,createdAt:2019-08-20T13:58:04.131Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:rbm-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5d5bfde5d1b5f1026fdff3b9,createdAt:2019-08-20T14:04:21.314Z,category:5d5bf6b77913cf004e75718a,parentDoc:5d5bfc6cd1b5f1026fdff395,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels}},results:{codes:{name:,code:\n {\n \id\: \6555093381403135744\,\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \rbm\: {\n \agent_name\: \My Agent\,\n \agent_state\: \launched\,\n \region\: \europe\\n }\n }\n,language:json,status:200}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:rbm-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d5fe8abf49b52004ee2ba09,createdAt:2019-08-23T13:22:51.376Z,parentDoc:5d5bfc6cd1b5f1026fdff395,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6555093381403135744}},results:{codes:{status:200,language:json,code:{\n \id\: \6555093381403135744\,\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \rbm\: {\n \agent_name\: \My Agent\,\n \agent_state\: \launched\,\n \region\: \europe\\n }\n},name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5d5fe9119c402d0043962540},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:rbm-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d5fead3808f0500231c6c91,createdAt:2019-08-23T13:32:03.047Z,parentDoc:5d5bfc6cd1b5f1026fdff395,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:json,code:{\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \2EeSWemjm3715k7wfceP\\n },\n \rbm\: {\n \agent_name\: \ACME\,\n \region\: \europe\\n }\n}}},results:{codes:{name:,code:{\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \2EeSWemjm3715k7wfceP\\n },\n \rbm\: {\n \agent_name\: \ACME\,\n \agent_state\: \new\,\n \region\: \europe\\n }\n},language:json,status:201}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `rbm`.,required:true,in:body,ref:,_id:5d5fead3808f0500231c6c93},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be generated from `rbm.agent_name`.,required:false,in:body,ref:,_id:5d5fead3808f0500231c6c92},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904fb},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c04ee3eabf2001f28d91a},{name:rbm.agent_name,type:string,enumValues:,default:,desc:Name of the agent as it is shown to end users.,required:true,in:body,ref:,_id:5d5fedbfcade02001e3904fa},{name:rbm.region,type:string,enumValues:,default:,desc:Region is needed for Agent registration in RBM. Allowed regions are `asia_pacific`, `europe` and `north_america`.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904f9},url:/v1/channels,method:post},isReference:true,order:2,slug:rbm-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d5ff31f2a8488006b596f19,createdAt:2019-08-23T14:07:27.055Z,parentDoc:5d5bfc6cd1b5f1026fdff395,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:{\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \2EeSWemjm3715k7wfceP\\n },\n \rbm\: {\n \agent_name\: \ACME\,\n \agent_state\: \new\,\n \region\: \europe\\n }\n},language:json,status:201},{name:,code:{},language:json,status:400}},examples:{codes:{code:{\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \2EeSWemjm3715k7wfceP\\n },\n \rbm\: {\n \agent_name\: \ACME\,\n \agent_state\: \create_requested\,\n \region\: \europe\\n }\n},language:json}},apiSetting:5d8abe2605260200d46221ab,auth:required,params:{name:name,type:string,enumValues:,default:,desc:Name of the channel.,required:false,in:body,ref:,_id:5d5fead3808f0500231c6c92},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:rbm-messages-text) requests will be accepted and sent through RBM. `test` - Send Message(ref:rbm-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message through RBM.,required:false,in:body,ref:,_id:5d5ff3f0952aef003c2fa1e5},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904fb},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c0515d07a50002767306e},{name:rbm.agent_name,type:string,enumValues:,default:,desc:Name of the agent as it is shown to end users.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904fa},{name:rbm.agent_state,type:string,enumValues:,default:,desc:Agent state(ref:section-agent-state) describes whether your agent is registered in RBM and whether it is launched.\u003cbr />\u003cbr />Allowed values are:\u003cbr />- `create_requested` when Agent State is `new`\u003cbr />- `launch_requested` when Agent State is `created`,required:false,in:body,ref:,_id:5d5ff3f0952aef003c2fa1e4},{name:rbm.region,type:string,enumValues:,default:,desc:Region is needed for Agent registration in RBM. Allowed regions are `asia_pacific`, `europe` and `north_america`.\u003cbr />\u003cbr />Can only changed when Agent State is `new`.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904f9},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:rbm-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d5ff4ab60c5af01826b4633,createdAt:2019-08-23T14:14:03.801Z,parentDoc:5d5bfc6cd1b5f1026fdff395,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:204,language:json,code: ,name:}},examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6555093381403135744}},apiSetting:5d8abe2605260200d46221ab,auth:required,params:{_id:5d275245afab2100181cbe99,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:rbm-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5d5ff4f2aab1b200259c5b95,createdAt:2019-08-23T14:15:14.392Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:rbm-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5d5ff522b09b52003b2276a9,createdAt:2019-08-23T14:16:02.530Z,parentDoc:5d5ff4f2aab1b200259c5b95,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:rbm-contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5d5ff5cf8062560052f9623d,createdAt:2019-08-23T14:18:55.287Z,parentDoc:5d5ff4f2aab1b200259c5b95,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n},name:OK}},apiSetting:5d8abe2605260200d46221ab,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:rbm-channels-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5d5ff6515514ce00645414d0,createdAt:2019-08-23T14:21:05.297Z,parentDoc:5d5ff4f2aab1b200259c5b95,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:rbm-contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5d5ff6acaab1b200259c5bbf,createdAt:2019-08-23T14:22:36.889Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:rbm-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5d622b6e685c9000516a8218,createdAt:2019-08-25T06:32:14.412Z,parentDoc:5d5ff6acaab1b200259c5bbf,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:rbm-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}}},{_id:5d273ddba3d7360243d48bab,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2019-07-11T13:47:07.460Z,order:8,slug:telegram,title:Telegram,__v:0,pages:{_id:5d273e1915b659001a5f7eb5,createdAt:2019-07-11T13:48:09.688Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-telegram,type:basic,title:Telegram,parentDoc:null,isBodyEmpty:false,children:},{_id:5d273fc59c6e3502d7823a6e,createdAt:2019-07-11T13:55:17.307Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:telegram-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5d49850cc4e4aa0159ff9d9b,createdAt:2019-08-06T13:47:56.598Z,category:5d273ddba3d7360243d48bab,parentDoc:5d273fc59c6e3502d7823a6e,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},apiSetting:5d8abe6e24e071001806f5d0,results:{codes:{name:,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \telegram\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,language:json,status:200},{name:,code:{},language:json,status:400}},auth:required,params:{_id:5b0ec704748b2c0003ee3d0a,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5b0ec704748b2c0003ee3d09,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:telegram-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:true,children:},{_id:5d275e041e20250044cc50e6,createdAt:2019-07-11T16:04:20.074Z,category:5d273ddba3d7360243d48bab,parentDoc:5d273fc59c6e3502d7823a6e,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6555093381403135744\\n },\n \contact\: {\n \id\: \6555112211957436097\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},results:{codes:{status:201,language:json,code:{\n \id\: \6555113982310240129\,\n \channel\: {\n \id\: \6555093381403135744\,\n \type\: \telegram\\n },\n \contact\: {\n \id\: \6555112211957436097\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:}},auth:required,params:{_id:5d275e2c7c55c4002aa2b452,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5d275e43922f8e003d9e1e6d,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:5d275e56a564c200183d3511,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:5d275e6e9c6e3502d7823ee9,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 4096 characters.,default:,type:string,name:content.payload},url:/v1/messages,method:post},isReference:true,order:1,slug:telegram-messages-text,type:endpoint,title:Text,isBodyEmpty:false,children:},{_id:66557b4203f0c7000fd31b01,api:{method:get,url:,auth:required,results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,examples:{codes:},params:},title:Quick Replies,icon:,type:basic,slug:quick-replies-copy,order:2,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d273fc59c6e3502d7823a6e,category:5d273ddba3d7360243d48bab,createdAt:2024-05-28T06:35:46.390Z,mdx:{},isBodyEmpty:false,children:},{_id:66557b24c024240013cf5de9,api:{method:post,url:/v1/messages/,auth:required,apiSetting:5e426de8bedf32005fb53c27,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.title,type:string,enumValues:,default:,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`. You can also omit the title attribute and use only `text` and `buttons` attributes.,required:false,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. **Max size** 80 characters. However, you can use **up to 640 characters** if you use text with buttons only.,required:false,in:body,ref:,_id:585b96556399952d00e0ac38},{name:content.payload.image_url,type:string,enumValues:,default:,desc:Url of an image to be displayed. Image ratio is 1.91:1.,required:false,in:body,ref:,_id:585b96556399952d00e0ac37},{name:content.payload.item_url,type:string,enumValues:,default:,desc:Url which is opened when the message is tapped.,required:false,in:body,ref:,_id:585b96556399952d00e0ac36},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:false,in:body,ref:,_id:585b96556399952d00e0ac35},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:amio-chat-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a58e527791cac001c857652}},title:Structure,icon:,type:endpoint,slug:structure-copy,order:3,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d273fc59c6e3502d7823a6e,category:5d273ddba3d7360243d48bab,createdAt:2024-05-28T06:35:16.506Z,isBodyEmpty:false,children:},{_id:66557b3803f0c7000fd31af8,api:{method:post,url:/v1/messages,auth:required,apiSetting:5e426a35dd81f5001b88b66e,settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108099701\,\n \channel\: {\n \id\: \6456078759331248741\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},name:}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331248741\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `image`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.url,type:string,enumValues:,default:,desc:Url of the image to be sent.,required:true,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.quick_replies,type:array_object,enumValues:,default:,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,required:false,in:body,ref:,_id:5e4267fc21a9040154db2bf6},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:amio-chat-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5e42684b5e1c780019935aa0}},title:Image,icon:,type:endpoint,slug:image-copy,order:4,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d273fc59c6e3502d7823a6e,category:5d273ddba3d7360243d48bab,createdAt:2024-05-28T06:35:36.260Z,isBodyEmpty:true,children:},{_id:66557b75b7406e002c572b3e,api:{method:post,url:/v1/messages/,auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `video`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.url,type:string,enumValues:,default:,desc:Url of the video to be sent. Max size is 25 MB.,required:true,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.quick_replies,type:array_object,enumValues:,default:,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,required:false,in:body,ref:,_id:59874a6ac66549000f043b40},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a16a3d6f7b5a0001e036bf6},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},name:}},settings:,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},language:json}},apiSetting:5d8e9b7719f4740011d43b89},title:Video,icon:,type:endpoint,slug:video-copy,order:5,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d273fc59c6e3502d7823a6e,category:5d273ddba3d7360243d48bab,createdAt:2024-05-28T06:36:37.280Z,isBodyEmpty:false,children:}},{_id:5d2748d11b6a1e02e31542e5,createdAt:2019-07-11T14:33:53.750Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:telegram-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5d274d627088ce004c19ecfa,createdAt:2019-07-11T14:53:22.676Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels}},results:{codes:{name:,code:\n {\n \id\: \6555093381403135744\,\n \type\: \telegram\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\,\n \name\: \Amio.io\,\n \username\: \amio_io_bot\\n }\n }\n,language:json,status:200}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:telegram-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d274fc5afab2100181cbe38,createdAt:2019-07-11T15:03:33.791Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6555093381403135744}},results:{codes:{status:200,language:json,code:{\n \id\: \6555093381403135744\,\n \type\: \telegram\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\,\n \name\: \Amio.io\,\n \username\: \amio_io_bot\\n }\n},name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5d274fc5afab2100181cbe39},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:telegram-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d2749522c897102b8a919dc,createdAt:2019-07-11T14:36:02.523Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:{\n \id\: \6555093381403135744\,\n \type\: \telegram\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\,\n \name\: \Amio.io\,\n \username\: \amio_io_bot\\n }\n},language:json,status:201}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `telegram`.,required:true,in:body,ref:,_id:5d274bf5a3d7360243d48d54},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, prefilled with the connected Telegram Bot name.,required:false,in:body,ref:,_id:5d274bf5a3d7360243d48d52},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5d274bf5a3d7360243d48d51},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c054d91c8d00031e15272},{name:telegram.access_token,type:string,enumValues:,default:,desc:Telegram Bot access token. It has to be unique since Telegram Bot account can be only assigned to one channel. You received this token when you created your Telegram Bot.,required:true,in:body,ref:,_id:5d274bf5a3d7360243d48d53},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d11a2fd24750251b7c223},url:/v1/channels,method:post,apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:json,code:{\n \type\: \telegram\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\\n }\n}}}},isReference:true,order:2,slug:telegram-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d27519c473480005c0aa9fa,createdAt:2019-07-11T15:11:24.656Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:json,code:{\n \name\: \New Name\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n }\n}}},results:{codes:{status:200,language:json,code:{\n \id\: \6555093381403135744\,\n \type\: \telegram\,\n \name\: \New Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\,\n \name\: \Amio.io\,\n \username\: \amio_io_bot\\n }\n},name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5d27519c473480005c0aa9fb},{name:name,type:string,enumValues:,default:,desc:Name of the channel.,required:false,in:body,ref:,_id:5d5d11edde9a8d01034119e2},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d11edde9a8d01034119e1},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5d5d11edde9a8d01034119e0},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c05d67eb0110011070dd9},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:telegram-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d275245afab2100181cbe98,createdAt:2019-07-11T15:14:13.536Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6555093381403135744}},results:{codes:{status:204,language:json,code: ,name:}},auth:required,params:{_id:5d275245afab2100181cbe99,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:telegram-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5d274f434c171c004a97bfa0,createdAt:2019-07-11T15:01:23.481Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:telegram-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5d2761251d33ed048e33ebdb,createdAt:2019-07-11T16:17:41.855Z,category:5d273ddba3d7360243d48bab,parentDoc:5d274f434c171c004a97bfa0,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6555093381403135744/contacts}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6555112211957436097\,\n \name\: \6555112211957436097\\n }\n,name:}},auth:required,params:{_id:5d2761251d33ed048e33ebde,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5d2761251d33ed048e33ebdd,ref:,in:query,required:false,desc:Maximum number of results to be returned. Cannot be more than 100.,default:,type:int,name:max},{_id:5d2761251d33ed048e33ebdc,ref:,in:query,required:false,desc:Skip first N results.,default:,type:int,name:offset},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:telegram-contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5d27618b2c897102b8a91d42,createdAt:2019-07-11T16:19:23.983Z,category:5d273ddba3d7360243d48bab,parentDoc:5d274f434c171c004a97bfa0,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6555093381403135744/contacts/6555112211957436097}},results:{codes:{status:200,language:json,code:{\n \id\: \6555112211957436097\,\n \name\: \6555112211957436097\\n},name:}},auth:required,params:{_id:5d276209a3d7360243d490a2,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5d276209a3d7360243d490a1,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:telegram-contacts-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5d2762251d33ed048e33ec07,createdAt:2019-07-11T16:21:57.617Z,category:5d273ddba3d7360243d48bab,parentDoc:5d274f434c171c004a97bfa0,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6555093381403135744/contacts/6555112211957436097}},results:{codes:{status:204,language:json,code: ,name:}},auth:required,params:{_id:5d27626a4c171c004a97c287,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5d27626a4c171c004a97c286,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:telegram-contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5d275c6238d460003eaa089d,createdAt:2019-07-11T15:57:22.238Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:telegram-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5d275c909c6e3502d7823e9f,createdAt:2019-07-11T15:58:08.193Z,category:5d273ddba3d7360243d48bab,parentDoc:5d275c6238d460003eaa089d,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:telegram-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:6666e0ca7a17cb0050c15777,api:{method:get,url:,auth:required,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},params:,examples:{codes:}},title:Message Echo,icon:,type:basic,slug:telegram-webhooks-message-echo,order:1,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:message-echo-copy,parentDoc:5d275c6238d460003eaa089d,category:5d273ddba3d7360243d48bab,createdAt:2024-06-10T11:17:30.990Z,isBodyEmpty:false,children:},{_id:6666dfa86fbeb30053429d95,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:Postback Received,icon:,type:basic,slug:telegram-webhooks-postback-received,order:2,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:postback-received,parentDoc:5d275c6238d460003eaa089d,category:5d273ddba3d7360243d48bab,createdAt:2024-06-10T11:12:40.164Z,isBodyEmpty:false,children:}}},{_id:59fc42803cf718001069b929,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,order:9,slug:viber,__v:0,reference:true,createdAt:2017-04-05T09:40:24.039Z,from_sync:false,title:Viber Bot,pages:{_id:59fc42803cf718001069b95c,hidden:false,isReference:true,order:0,slug:api-viber,title:Viber Bot,link_external:false,link_url:,api:{results:{codes:{status:200,language:json,code:{},name:},{code:{},name:,status:400,language:json}},auth:required,params:,url:,method:get},sync_unique:,type:basic,createdAt:2017-04-05T09:41:39.622Z,parentDoc:null,category:59fc42803cf718001069b929,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b95d,link_url:,order:1,createdAt:2017-04-05T11:13:04.716Z,hidden:false,isReference:true,type:basic,slug:viber-messages,sync_unique:,title:Messages,link_external:false,parentDoc:null,api:{url:,method:get,results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:},category:59fc42803cf718001069b929,isBodyEmpty:false,children:{_id:5a70733ec3cfa000542fbd59,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b95d,createdAt:2018-01-30T13:29:34.559Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078781510718339\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078759331238786\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,name:}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{_id:5a7071e1b3c9580024d1a2f5,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a7071e1b3c9580024d1a2f4,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:viber-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b95e,api:{settings:,url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 320 characters.,default:,type:string,name:content.payload},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:null}},apiSetting:5d8abeb7e83f7e0024e19041},parentDoc:59fc42803cf718001069b95d,sync_unique:,type:endpoint,category:59fc42803cf718001069b929,isReference:true,link_external:false,link_url:,slug:viber-messages-text,title:Text,hidden:false,order:1,createdAt:2017-04-05T11:19:56.437Z,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b95f,hidden:false,link_external:false,order:2,parentDoc:59fc42803cf718001069b95d,slug:viber-messages-image,category:59fc42803cf718001069b929,api:{url:/v1/messages,auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:payload.url},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},name:}},settings:,apiSetting:5d8ea08fd89cd90046594b52},createdAt:2017-04-05T11:26:16.769Z,title:Image,isReference:true,link_url:,sync_unique:,type:endpoint,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b960,createdAt:2017-04-05T11:26:30.710Z,order:3,api:{auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `video`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the video to be sent. Allowed formats are **MP4** and **H264**. Max size is 50 MB. Max duration is 180 seconds.,default:,type:string,name:payload.url},results:{codes:{code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},name:,status:201,language:json}},settings:,url:/v1/messages,apiSetting:5d8ea140589ec60039e75dd9},hidden:false,parentDoc:59fc42803cf718001069b95d,slug:viber-messages-video,sync_unique:,category:59fc42803cf718001069b929,isReference:true,link_url:,title:Video,type:endpoint,link_external:false,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b961,type:endpoint,slug:viber-messages-file,hidden:false,isReference:true,link_url:,parentDoc:59fc42803cf718001069b95d,createdAt:2017-04-05T11:27:29.639Z,title:File,category:59fc42803cf718001069b929,link_external:false,order:4,sync_unique:,api:{url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \https://example.com/file.pdf\\n }\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `file`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the file to be sent.,default:,type:string,name:payload.url},results:{codes:{status:201,name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \https://example.com/file.pdf\\n }\n }\n},language:json}},settings:,apiSetting:5d8ea1e2255ef80065c71ab4},isBodyEmpty:false,children:},{_id:59fc42803cf718001069b962,api:{results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},settings:,url:/v1/messages,auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `structure`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:false,desc:Title of the message. It is displayed on one line and the text is truncated with ellipsis (three dots in the end) if exceeds the line. You can usually fit up to **20 characters**.,default:,type:string,name:payload.title},{_id:585b96556399952d00e0ac38,ref:,in:body,required:false,desc:Message text. It is displayed on 3 lines if zero or one button is used or on one line if more buttons are used. Thats enough space for approximately **65 characters** or **22 characters** respectively.,default:,type:string,name:payload.text},{_id:585b96556399952d00e0ac37,ref:,in:body,required:false,desc:Url of an image to be displayed. Image ratio is 1.91:1.,default:,type:string,name:payload.image_url},{_id:585b96556399952d00e0ac36,ref:,in:body,required:false,desc:Url which is opened when the message is tapped.,default:,type:string,name:payload.item_url},{_id:585b96556399952d00e0ac35,ref:,in:body,required:false,desc:Buttons to be shown below the message. Limitted to 3 buttons. See Buttons(ref:viber-messages-buttons) chapter for more details.,default:,type:array_object,name:payload.buttons},{_id:5a58e55c086a05001c43238d,ref:,in:body,required:false,desc:Metadata(ref:viber-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:viber-webhooks-message-echo) webhook.,default:,type:string,name:metadata},apiSetting:5d8ea25e31d0eb00385066dc},hidden:false,type:endpoint,parentDoc:59fc42803cf718001069b95d,slug:viber-messages-structure-viber,isReference:true,link_external:false,link_url:,sync_unique:,title:Structure,category:59fc42803cf718001069b929,createdAt:2017-04-05T11:27:42.524Z,order:5,isBodyEmpty:false,children:},{_id:5a58e584086a05001c432390,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b95d,createdAt:2018-01-12T16:42:44.601Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ea29a4794a30018945b36,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n},language:json}},settings:,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \buttons\: \n {\n \payload\: \https://example.com/daily-menu/food-1\,\n \type\: \url\,\n \title\: \Show Details\\n }\n ,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \text\: \9.5 €\,\n \title\: \Leaf salad\\n },\n {\n \buttons\: \n {\n \payload\: \https://example.com/daily-menu/food-2\,\n \type\: \url\,\n \title\: \Show Details\\n }\n ,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \text\: \12.0 €\,\n \title\: \Beef burger with Coleslaw salad\\n }\n \n }\n},language:json,status:201}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `structure`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:false,desc:Title of the message. It is displayed on one line and the text is truncated with ellipsis (three dots in the end) if exceeds the line. You can usually fit up to **20 characters**.,default:,type:string,name:payload.title},{_id:585b96556399952d00e0ac38,ref:,in:body,required:false,desc:Message text. It is displayed on 3 lines if zero or one button is used or on one line if more buttons are used. Thats enough space for approximately **65 characters** or **22 characters** respectively.,default:,type:string,name:payload.text},{_id:585b96556399952d00e0ac37,ref:,in:body,required:false,desc:Url of an image to be displayed. Image ratio is 1.91:1.,default:,type:string,name:payload.image_url},{_id:585b96556399952d00e0ac36,ref:,in:body,required:false,desc:Url which is opened when the message is tapped.,default:,type:string,name:payload.item_url},{_id:585b96556399952d00e0ac35,ref:,in:body,required:false,desc:Buttons to be shown below the message. Limitted to 3 buttons. See Buttons(ref:viber-messages-buttons) chapter for more details.,default:,type:array_object,name:payload.buttons},{_id:5a58e55c086a05001c43238d,ref:,in:body,required:false,desc:Metadata(ref:viber-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:viber-webhooks-message-echo) webhook.,default:,type:string,name:metadata},url:/v1/messages,method:post},isReference:true,order:6,slug:viber-messages-structure-horizontal-scroll,type:endpoint,title:Structure - Horizontal Scroll,isBodyEmpty:false,children:},{_id:5a58df9c2e799c003047b900,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b95d,createdAt:2018-01-12T16:17:32.267Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:7,slug:viber-messages-buttons,type:basic,title:Buttons,isBodyEmpty:false,children:},{_id:5a16a4a59610050012c4a2f8,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b95d,createdAt:2017-11-23T10:36:21.980Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:8,slug:viber-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:}},{_id:5a1d683121ea8a00123be93c,category:59fc42803cf718001069b929,createdAt:2017-11-28T13:44:17.392Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:viber-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5a1d6862983d8e0012708c7c,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T13:45:06.722Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abeb7e83f7e0024e19041,results:{codes:{name:OK,code:\n {\n \id\: \6456078759331238786\,\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber\: {\n \name\: \Amio\,\n \category\: \Companies, Brands & Products\,\n \uri\: \amioio\,\n \access_token\: \46c9501a7eefc1ab\\n }\n }\n,language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:viber-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d6a02721b9a0026bbd37c,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T13:52:02.202Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber\: {\n \name\: \Amio\,\n \category\: \Companies, Brands & Products\,\n \uri\: \amioio\,\n \access_token\: \46c9501a7eefc1ab\\n }\n},language:json,status:200}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d6a419d3741002afd4d9a},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:viber-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d6ab767d310001245c5c4,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T13:55:03.679Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abeb7e83f7e0024e19041,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber\: {\n \name\: \Amio\,\n \category\: \Companies, Brands & Products\,\n \uri\: \amioio\,\n \access_token\: \46c9501a7eefc1ab\\n }\n},language:json,status:201}},examples:{codes:{language:json,code:{\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \viber\: {\n \access_token\: \46c9501a7eefc1ab\\n }\n}}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `viber`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be filled with connected Viber Bot name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d129518349a002cb91719},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c05f9afbdba00428837a2},{name:viber.access_token,type:string,enumValues:,default:,desc:Viber Bot account access token. It has to be unique as Viber Bot account can be assigned only to one channel. You receive this token from Viber.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b5},url:/v1/channels,method:post},isReference:true,order:2,slug:viber-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d706821ea8a00123bea7d,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T14:19:20.206Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n }\n},language:json}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber\: {\n \name\: \Amio\,\n \category\: \Companies, Brands & Products\,\n \uri\: \amioio\,\n \access_token\: \46c9501a7eefc1ab\\n }\n},language:json,status:200}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d70ca721b9a0026bbd418},{name:name,type:string,enumValues:,default:,desc:Name of the channel. Might be an arbitrary name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d12d74670d90037f7e91b},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c061a2de62e0018933f3b},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:viber-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d714f983d8e0012708d99,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T14:23:11.267Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:viber-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5a13197d45769d002674f236,category:59fc42803cf718001069b929,createdAt:2017-11-20T18:05:49.125Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:viber-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5a1319d0b57953001cece1ac,category:59fc42803cf718001069b929,parentDoc:5a13197d45769d002674f236,createdAt:2017-11-20T18:07:12.011Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abeb7e83f7e0024e19041,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\,\n \locale\: \de_DE\,\n \photo_url\: \https://scontent.xx.fbcdn.net/v/t1.0-1/541992_511761562179706_48931455_n.jpg?oh1b30d9f950c70b19cf99ef8ea81a169e&oe5A5108B3\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:viber-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5a131a1745769d002674f239,category:59fc42803cf718001069b929,parentDoc:5a13197d45769d002674f236,createdAt:2017-11-20T18:08:23.712Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},results:{codes:{name:OK,code:{\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\,\n \locale\: \de_DE\,\n \photo_url\: \https://scontent.xx.fbcdn.net/v/t1.0-1/541992_511761562179706_48931455_n.jpg?oh1b30d9f950c70b19cf99ef8ea81a169e&oe5A5108B3\\n},language:json,status:200}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:viber-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5a131a23ddc95100120c4a66,category:59fc42803cf718001069b929,parentDoc:5a13197d45769d002674f236,createdAt:2017-11-20T18:08:35.265Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abeb7e83f7e0024e19041,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:viber-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:59fc42803cf718001069b964,link_external:false,parentDoc:null,createdAt:2017-04-05T12:38:42.588Z,hidden:false,link_url:,slug:viber-webhooks,type:basic,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,category:59fc42803cf718001069b929,order:4,sync_unique:,title:Webhooks,isBodyEmpty:false,children:{_id:59fc42803cf718001069b965,link_external:false,hidden:false,sync_unique:,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},createdAt:2017-04-05T12:38:51.319Z,slug:viber-webhooks-message-received,title:Message Received,isReference:true,link_url:,order:0,parentDoc:59fc42803cf718001069b964,type:basic,category:59fc42803cf718001069b929,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a467b576b2de2001c5838ff,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b964,createdAt:2017-12-29T17:28:55.386Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:1,slug:viber-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5a467da86b2de2001c583922,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b964,createdAt:2017-12-29T17:38:48.526Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:2,slug:viber-webhooks-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:5b0fff057d6ce90003071a32,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b964,createdAt:2018-05-31T13:56:21.101Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:3,slug:viber-webhooks-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b966,order:4,sync_unique:,link_url:,title:Message Echo,type:basic,category:59fc42803cf718001069b929,createdAt:2017-04-05T13:13:26.838Z,hidden:false,isReference:true,link_external:false,parentDoc:59fc42803cf718001069b964,slug:viber-webhooks-message-echo,api:{results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isBodyEmpty:false,children:},{_id:5a5a63a391d40f001e6e08a3,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b964,createdAt:2018-01-13T19:53:07.964Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:viber-webhooks-postback-received,type:basic,title:Postback Received,isBodyEmpty:false,children:}}},{_id:5b6d89a09d346300038baf55,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2018-08-10T12:48:32.519Z,from_sync:false,order:10,slug:viber-business-messages,title:Viber Business Messages,__v:0,pages:{_id:5b717d825b81530003aa7adf,category:5b6d89a09d346300038baf55,parentDoc:null,createdAt:2018-08-13T12:45:54.204Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-viber-business-messages,type:basic,title:Viber Business Messages,isBodyEmpty:false,children:},{_id:5b6d89da8ffb3900032cd5e4,category:5b6d89a09d346300038baf55,createdAt:2018-08-10T12:49:30.685Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:viber-business-messages-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5b6d8ef19d346300038baf8d,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:11:13.946Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},results:{codes:{name:,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,language:json,status:200}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a7071e1b3c9580024d1a2f5},{name:contact_id,type:string,enumValues:,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5a7071e1b3c9580024d1a2f4},{name:max,type:int,enumValues:,default:10,desc:Maximum number of messages to be listed. Values larger than 100 are accepted but the list will never contain more than 100 messages.,required:false,in:query,ref:,_id:60c89904dae32b00230cf89f},{name:offset,type:int,enumValues:,default:0,desc:Offset of the starting position in the message list.,required:false,in:query,ref:,_id:60c89904dae32b00230cf89e},{name:since,type:string,enumValues:,default:unlimited,desc:Allows filtering messages by date. Must be in ISO 8601 format.,required:false,in:query,ref:,_id:60c89904dae32b00230cf89d},{name:before,type:string,enumValues:,default:unlimited,desc:Allows filtering messages by date. Must be in ISO 8601 format.,required:false,in:query,ref:,_id:60c89904dae32b00230cf89c},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:viber-business-list-messages,type:endpoint,title:List Messages,previousSlug:,isBodyEmpty:false,children:},{_id:5b6d8eff9218840003992b61,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:11:27.442Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:null}},examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1-555-857-6309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},settings:,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Phone number of the contact.,default:,type:string,name:contact.phone_number},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 1000 characters.,default:,type:string,name:content.payload},url:/v1/messages,method:post},isReference:true,order:1,slug:viber-business-messages-text,type:endpoint,title:Text,isBodyEmpty:false,children:},{_id:5b6d8f0873acbe000364a4d7,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:11:36.046Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8e9f9ef9188300738106b5,settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},name:}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1-555-857-6309\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Phone number of the contact.,default:,type:string,name:contact.phone_number},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:payload.url},url:/v1/messages,method:post},isReference:true,order:2,slug:viber-business-messages-image,type:endpoint,title:Image,isBodyEmpty:false,children:},{_id:5b6d8f16d1d33e0003f0c59d,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:11:50.759Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ea00cfb26fa001c90b78d,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1-555-857-6309\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\\n\t},\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Phone number of the contact.,default:,type:string,name:contact.phone_number},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `structure`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:false,desc:Title of the message. Max **80 characters**.,default:,type:string,name:payload.title},{_id:585b96556399952d00e0ac38,ref:,in:body,required:false,desc:Message text. Max **900 characters**, text is wrapped to lines.,default:,type:string,name:payload.text},{_id:585b96556399952d00e0ac37,ref:,in:body,required:false,desc:Url of an image to be displayed. Image ratio is 1.91:1.,default:,type:string,name:payload.image_url},{_id:585b96556399952d00e0ac36,ref:,in:body,required:false,desc:Url which is opened when the message is tapped.,default:,type:string,name:payload.item_url},{_id:585b96556399952d00e0ac35,ref:,in:body,required:false,desc:Buttons to be shown below the message. Viber Business Messages only support 1 button.,default:,type:array_object,name:payload.buttons},{_id:5a58e55c086a05001c43238d,ref:,in:body,required:false,desc:Metadata(ref:viber-business-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:viber-business-webhooks-message-echo) webhook.,default:,type:string,name:metadata},url:/v1/messages,method:post},isReference:true,order:3,slug:viber-business-messages-structure,type:endpoint,title:Structure,isBodyEmpty:false,children:},{_id:5b6d8f418ffb3900032cd642,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:12:33.580Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:viber-business-messages-buttons,type:basic,title:Buttons,isBodyEmpty:false,children:},{_id:5b6d8f4a73acbe000364a4e4,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:12:42.400Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:viber-business-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:}},{_id:5b6d981173acbe000364a59e,category:5b6d89a09d346300038baf55,createdAt:2018-08-10T13:50:09.359Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:viber-business-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5b6d98219d346300038bb011,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:50:25.041Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\,\n \name\: \Viber Business Messages - Example\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT24H\,\n \approved\: true,\n }\n }\n,name:OK}},apiSetting:5d8ac09de7b73f03363d49cc,auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:viber-business-channels-list,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b6d98299d346300038bb012,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:50:33.082Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,results:{codes:{status:200,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT24H\,\n \approved\: true,\n }\n},name:OK}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d6a419d3741002afd4d9a},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:viber-business-channels-get,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b6d98319d346300038bb013,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:50:41.748Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \type\: \viber_business_messages\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT1H\,\n }\n}}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT1H\,\n \approved\: false,\n }\n},language:json,status:201}},apiSetting:5d8ac09de7b73f03363d49cc,auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `viber_business_messages`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be generated automatically.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:viber-business-messages-text) requests will be accepted and sent through Viber network. `sandbox ` - Send Message(ref:viber-business-messages-text) requests will be sent using common Amio Sender ID. Messages sent are not charged but number of messages sent is limited. `test` - Send Message(ref:viber-business-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message through Viber.,required:false,in:body,ref:,_id:5d5d13404670d90037f7e92e},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c064b600631001ca317db},{name:viber_business_messages.sender_id,type:string,enumValues:,default:,desc:The Sender ID will be shown in the Viber app as a sender of the message. You wont be able to change the Sender ID once its registered with Viber.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b5},{name:viber_business_messages.default_message_ttl,type:string,enumValues:,default:PT24H,desc:Message validity period. If the message couldnt be delivered within this period, it will be discarded. Value should be provided in (ISO 8601 duration(https://en.wikipedia.org/wiki/ISO_8601#Durations)).,required:false,in:body,ref:,_id:5c73e9f8d685480024df009f},url:/v1/channels,method:post},isReference:true,order:2,slug:viber-business-channels-create,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b6d98399d346300038bb014,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:50:49.967Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT20M\,\n \approved\: false,\n }\n},language:json,status:200}},examples:{codes:{language:json,code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \viber_business_messages\: {\n \default_message_ttl\: \PT20M\,\n }\n}}},auth:required,params:{_id:5a1d70ca721b9a0026bbd418,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a1c459dacac6b001e666b52,ref:,in:body,required:false,desc:Name of the channel. Might be an arbitrary name.,default:,type:string,name:name},{_id:5d5d147bb8da6d006cabaea8,ref:,in:body,required:false,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:viber-business-messages-text) requests will be accepted and sent through Viber network. `sandbox ` - Send Message(ref:viber-business-messages-text) requests will be sent using common Amio Sender ID. Messages sent are not charged but number of messages sent is limited. `test` - Send Message(ref:viber-business-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message through Viber.,default:,type:string,name:mode},{_id:5a1c40a1c73b44001ed59949,ref:,in:body,required:false,desc:Webhook url where all channel events would be sent to.,default:,type:string,name:webhook.url},{_id:5e3c06833eabf2001f28d924,ref:,in:body,required:false,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,default:,type:string,name:webhook.secret},{_id:5c73ea4eaa37f400629dd8e0,ref:,in:body,required:false,desc:Message validity period. If the message couldnt be delivered within this period, it will be discarded. Value should be provided in (ISO 8601 duration(https://en.wikipedia.org/wiki/ISO_8601#Durations)).,default:PT24H,type:string,name:viber_business_messages.default_message_ttl},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:viber-business-channels-update,type:endpoint,title:Update Channel,isBodyEmpty:false,children:},{_id:5b6d984473acbe000364a5a0,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:51:00.350Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:viber-business-channels-delete,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5b715f400b125a00032a990a,category:5b6d89a09d346300038baf55,createdAt:2018-08-13T10:36:48.584Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:viber-business-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5b715f516a90fc00037b4d43,category:5b6d89a09d346300038baf55,parentDoc:5b715f400b125a00032a990a,createdAt:2018-08-13T10:37:05.086Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n }\n,name:OK}},apiSetting:5d8ac09de7b73f03363d49cc,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:viber-business-contacts-list,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5b715f6c6a90fc00037b4d44,category:5b6d89a09d346300038baf55,parentDoc:5b715f400b125a00032a990a,createdAt:2018-08-13T10:37:32.033Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n},name:OK}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:viber-business-contacts-get,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5b715f73a373290003f803ca,category:5b6d89a09d346300038baf55,parentDoc:5b715f400b125a00032a990a,createdAt:2018-08-13T10:37:39.699Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},apiSetting:5d8ac09de7b73f03363d49cc,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:viber-business-contacts-delete,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5b7162260b125a00032a9959,category:5b6d89a09d346300038baf55,createdAt:2018-08-13T10:49:10.881Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:viber-business-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5b7162346a90fc00037b4d95,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:24.735Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:viber-business-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b71623d6711770003dbce94,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:33.869Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:viber-business-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5b71624a6711770003dbce96,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:46.541Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:viber-business-webhooks-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:5b7162446711770003dbce95,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:40.303Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:viber-business-webhooks-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:5b7162520b125a00032a995a,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:54.472Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:viber-business-webhooks-message-echo,type:basic,title:Message Echo,isBodyEmpty:false,children:}}},{_id:5d9330eb95026a001227fbf4,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2019-10-01T10:56:43.295Z,order:11,slug:whatsapp-1,title:WhatsApp,__v:0,pages:{_id:5d933189bc1938002815a6df,createdAt:2019-10-01T10:59:21.759Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-whatsapp,type:basic,title:WhatsApp,parentDoc:null,isBodyEmpty:false,children:},{_id:5d9331ec158aea0041576002,createdAt:2019-10-01T11:01:00.705Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:whatsapp-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5d9da9b8020606005e46c795,createdAt:2019-10-09T09:34:48.954Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:whatsapp-messages-handling-errors,type:basic,title:Handling Message Errors,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d93324768618100fd3d4a4d,createdAt:2019-10-01T11:02:31.913Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},apiSetting:5d933029747232001ae76e83,auth:required,params:{_id:5a7071e1b3c9580024d1a2f5,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a7071e1b3c9580024d1a2f4,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:1,slug:whatsapp-messages-messages,type:endpoint,title:List Messages,isBodyEmpty:false,children:},{_id:5d9332c32e9e10002fe5b2cd,createdAt:2019-10-01T11:04:35.391Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{settings:,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:null}},apiSetting:5d933029747232001ae76e83,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Phone number of the contact.,default:,type:string,name:contact.phone_number},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 4096 characters. The text can be formatted(ref:whatsapp-messages-text-formatting).,default:,type:string,name:content.payload},url:/v1/messages,method:post},isReference:true,order:2,slug:whatsapp-messages-text,type:endpoint,title:Text,isBodyEmpty:false,children:},{_id:5d933d39158aea00415760e4,createdAt:2019-10-01T11:49:13.331Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:whatsapp-messages-text-formatting,type:basic,title:Formatting in Text Messages,isBodyEmpty:false,children:},{_id:5db330c00bcbdb003652d13a,createdAt:2019-10-25T17:28:32.898Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5db32d82109f9600329bdad4,settings:,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json,status:201}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:content.payload.url},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:4,slug:whatsapp-messages-image,type:endpoint,title:Image,isBodyEmpty:false,children:},{_id:5e342065d3a47601de5e8475,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,createdAt:2020-01-31T00:52:49.133Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \audio\,\n \payload\: {\n \url\: \https://amio-testing.s3.eu-central-1.amazonaws.com/amio-communicator/audio.mp3\\n }\n }\n},language:json}},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \audio\,\n \payload\: {\n \url\: \https://amio-testing.s3.eu-central-1.amazonaws.com/amio-communicator/audio.mp3\\n }\n }\n},language:json,status:201}},settings:,apiSetting:5db32dff3ad555003555560c,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `audio`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the audio to be sent.,default:,type:string,name:content.payload.url},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:5,slug:whatsapp-messages-audio,type:endpoint,title:Audio,isBodyEmpty:false,children:},{_id:5e3424817dd55f01f93e17db,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,createdAt:2020-01-31T01:09:23.862Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5db32dc5452066001d83c181,settings:,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\\n }\n }\n},language:json,status:201}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `file`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the file to be sent.,default:,type:string,name:content.payload.url},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:6,slug:whatsapp-messages-file,type:endpoint,title:File,isBodyEmpty:false,children:},{_id:5e3427de7dd55f01f93e17fc,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,createdAt:2020-01-31T01:09:23.862Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://techslides.com/demos/sample-videos/small.mp4\\n }\n }\n},language:json}},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://techslides.com/demos/sample-videos/small.mp4\\n }\n }\n},language:json,status:201}},settings:,apiSetting:5e3425a097e32d020fa788b5,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `video`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the video to be sent.,default:,type:string,name:content.payload.url},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:7,slug:whatsapp-messages-video,type:endpoint,title:Video,isBodyEmpty:false,children:},{_id:5e57d130391ffb002c16a762,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,createdAt:2020-02-27T14:11:55.497Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5e57cf5e9c7e970072b7dcf4,settings:,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \location\,\n \payload\: {\n \address\: \Great Russell St, Bloomsbury, London WC1B 3DG, United Kingdom\,\n \latitude\: 51.519421,\n \name\: \The British Museum\,\n \longitude\: -0.126946\n }\n }\n},language:json,status:201}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \location\,\n \payload\: {\n \name\: \The British Museum\,\n \address\: \Great Russell St, Bloomsbury, London WC1B 3DG, United Kingdom\,\n \latitude\: 51.519421,\n \longitude\: -0.126946\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `location`.,default:,type:string,name:content.type},{_id:5e57d130391ffb002c16a766,ref:,in:body,required:false,desc:Location name or title.,default:,type:string,name:content.payload.name},{_id:5e57d130391ffb002c16a765,ref:,in:body,required:false,desc:Location address.,default:,type:string,name:content.payload.address},{_id:5e57d130391ffb002c16a764,ref:,in:body,required:true,desc:Location latitude.,default:,type:string,name:content.payload.latitude},{_id:5e57d130391ffb002c16a763,ref:,in:body,required:true,desc:Location longitude,default:,type:string,name:content.payload.longitude},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:8,slug:whatsapp-messages-location,type:endpoint,title:Location,isBodyEmpty:false,children:},{_id:60cc8ee1e70ec00335b8f54a,api:{method:post,url:/v1/messages,auth:required,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \text\:\🚚📦 Your Order #12374 has been shipped\,\n \buttons\: \n {\n \type\:\postback\,\n \title\: \Track Package\,\n \payload\: \button_payload1\\n },\n {\n \type\:\postback\,\n \title\: \Get Receipt\,\n \payload\: \button_payload2\\n },\n {\n \type\:\postback\,\n \title\: \Change Address\,\n \payload\: \button_payload3\\n }\n \n }\n }\n},language:json,status:201}},params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:60cca2cdbb976f0052f91c15},{name:contact.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:60cca2cdbb976f0052f91c14},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:60cca2cdbb976f0052f91c13},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. Max **1024 characters**.,required:true,in:body,ref:,_id:60cca2cdbb976f0052f91c12},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown in the message menu. Maximum number of buttons is 10.,required:false,in:body,ref:,_id:60cca2cdbb976f0052f91c11},{name:content.payload.buttons.type,type:string,enumValues:,default:,desc:Type of the button. Only `postback` is supported.,required:false,in:body,ref:,_id:60cca2cdbb976f0052f91c10},{name:content.payload.buttons.title,type:string,enumValues:,default:,desc:Title of the button. Maximum length is 20 characters.,required:false,in:body,ref:,_id:60cca2cdbb976f0052f91c0f},{name:content.payload.buttons.payload,type:string,enumValues:,default:,desc:Any arbitrary data. When user presses the button, you will receive this data as part of Postback Received(#whatsapp-webhooks-postback-received) webhook. Maximum length is 1000 characters.,required:false,in:body,ref:,_id:60cca2cdbb976f0052f91c0e},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \text\:\🚚📦 Your Order #12374 has been shipped\,\n \buttons\: \n {\n \type\:\postback\,\n \title\: \Track Package\,\n \payload\: \button_payload1\\n },\n {\n \type\:\postback\,\n \title\: \Get Receipt\,\n \payload\: \button_payload2\\n },\n {\n \type\:\postback\,\n \title\: \Change Address\,\n \payload\: \button_payload3\\n }\n \n }\n }\n},language:json}},apiSetting:60cc8f6f14124402d889f542},title:Structure,type:endpoint,slug:whatsapp-messages-structure,order:9,isReference:true,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:structure,createdAt:2021-06-18T12:17:37.144Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,isBodyEmpty:false,children:},{_id:60ed5a8bb8ba68005673318f,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Quick Replies,type:basic,slug:whatsapp-messages-quick-replies,order:10,isReference:true,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:quick-replies,createdAt:2021-07-13T09:19:07.351Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,isBodyEmpty:false,children:}},{_id:5dce99c55b0983002636fc2e,createdAt:2019-11-15T12:27:49.151Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:whatsapp-templates,type:basic,title:Templates,parentDoc:null,isBodyEmpty:false,children:{_id:5dcea7257a2bb900188a3f9b,createdAt:2019-11-15T13:24:53.089Z,parentDoc:5dce99c55b0983002636fc2e,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:whatsapp-sending-templates,type:basic,title:Sending Templates,isBodyEmpty:false,children:},{_id:5dcea138118e08002eab7a45,createdAt:2019-11-15T12:59:36.800Z,parentDoc:5dce99c55b0983002636fc2e,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dce9fdc841080003e5bb4f6,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Welcome to Amio, Albert! We are ready to help you succeed with messaging. 🚀\\n }\n},name:null}},examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1-555-857-6309\\n },\n \message_template\: {\n \id\: \4726078759445238153\,\n \substitution\: {\n \localizations\: {\n \default\: {\n \name\: \Albert\\n }\n }\n }\n }\n}}},settings:,auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.phone_number,type:string,enumValues:,default:,desc:Phone number of the contact.,required:true,in:body,ref:,_id:586d2081a63f5d2500c86b83},{name:message_template.id,type:string,enumValues:,default:,desc:ID of a template that will be used. At the moment, ask us for the ID at support@amio.io .,required:true,in:body,ref:,_id:586d20b39a854123001acd78},{name:message_template.substitution,type:object,enumValues:,default:,desc:Substitution hold localized substitutions that will be used to replace placeholders in the template.,required:true,in:body,ref:,_id:586d20b39a854123001acd77},{name:message_template.localizations,type:object,enumValues:,default:,desc:Keys are locales(https://docs.amio.io/v1.0/reference#locale) and `default`. Currently we support only `default` which must always be provided.,required:true,in:body,ref:,_id:5dcea43041c9ab05e875dbce},{name:message_template.substitution.localizations. {{locale_or_default}},type:object,enumValues:,default:,desc:Keys are placeholders from the template with their values that will be replaced in the template.,required:true,in:body,ref:,_id:5dcea43041c9ab05e875dbcd},url:/v1/messages,method:post},isReference:true,order:1,slug:whatsapp-templates-text,type:endpoint,title:Text,deprecated:false,icon:,previousSlug:,isBodyEmpty:false,children:}},{_id:5dd67ed931e918096878ce59,createdAt:2019-11-21T12:11:05.553Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:whatsapp-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5dd683fe988ad608fac5812f,createdAt:2019-11-21T12:33:02.336Z,parentDoc:5dd67ed931e918096878ce59,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d933029747232001ae76e83,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\,\n \name\: \WhatsApp - IT Crowd\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \whatsapp_business_account\: {\n \phone_number\: \01189998819991197253\,\n }\n }\n,name:OK}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:whatsapp-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5dd687d99d66f509ffdf1773,createdAt:2019-11-21T12:49:29.454Z,parentDoc:5dd67ed931e918096878ce59,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \whatsapp\,\n \name\: \WhatsApp - IT Crowd\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \whatsapp_business_account\: {\n \phone_number\: \01189998819991197253\,\n }\n},name:OK}},apiSetting:5d933029747232001ae76e83,auth:required,params:,url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:whatsapp-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5e1725600c209503d87a005a,parentDoc:5dd67ed931e918096878ce59,category:5d9330eb95026a001227fbf4,createdAt:2020-01-09T05:32:28.559Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d933029747232001ae76e83,results:{codes:{status:201,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \whatsapp\,\n \name\: \Your WA Business Account\,\n \mode\: \sandbox\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \whatsapp_business_account\: {\n \t\phone_number\: \+11 123 456 789\\n }\n},name:OK}},examples:{codes:{language:json,code:{\n \type\: \whatsapp\,\n \name\: \Your WA Business Account\,\n \mode\: \sandbox\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \whatsapp_business_account\: {\n \t\phone_number\: \+11 123 456 789\\n }\n}\n }},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `whatsapp`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be generated automatically.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:viber-business-messages-text) requests will be accepted and sent through Viber network. `sandbox ` - Send Message(ref:viber-business-messages-text) requests will be sent using common Amio Sender ID. Messages sent are not charged but number of messages sent is limited. `test` - Send Message(ref:viber-business-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message through Viber.,required:false,in:body,ref:,_id:5d5d13404670d90037f7e92e},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:whatsapp_business_account.phone_number,type:string,enumValues:,default:,desc:The phone number that your customers will use to reach your WhatsApp Business Account.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b5},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c0834938acf002595c031},url:/v1/channels,method:post},isReference:true,order:2,slug:whatsapp-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:5e46b7347e7c320031110b03,category:5d9330eb95026a001227fbf4,createdAt:2020-02-14T15:03:03.632Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:whatsapp-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5e46b87a6d0858007275e9c5,parentDoc:5e46b7347e7c320031110b03,category:5d9330eb95026a001227fbf4,createdAt:2020-02-13T23:52:45.030Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d933029747232001ae76e83,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \Steve\,\n \platform_id\: \15558576309\,\n \phone_number\: \1555857309\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:whatsapp-contacts-list,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5e46b8f7e86f960011ba52a2,parentDoc:5e46b7347e7c320031110b03,category:5d9330eb95026a001227fbf4,createdAt:2020-02-13T23:52:44.192Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\,\n \name\: \Steve\\n},name:OK}},apiSetting:5d933029747232001ae76e83,auth:required,params:{name:channel_id,type:string,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:58d26787eb28591900333600},{name:contact_id,type:string,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5a0aa45d2aad4d001ad60cd0},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:whatsapp-contacts-get,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5e46b91fbf875d00582642ef,parentDoc:5e46b7347e7c320031110b03,category:5d9330eb95026a001227fbf4,createdAt:2020-02-14T15:12:52.621Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d933029747232001ae76e83,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:whatsapp-contacts-delete,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5d95b43da0150a00249740c1,createdAt:2019-10-03T08:41:33.758Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:whatsapp-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5d95b415c1d7cf005cf10798,createdAt:2019-10-03T08:40:53.899Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:whatsapp-webhooks-message-received,type:basic,title:Message Received,previousSlug:,deprecated:false,icon:,mdx:{},isBodyEmpty:false,children:},{_id:5def96c21038430018a137f0,createdAt:2019-12-10T12:59:46.876Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:1,slug:whatsapp-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5def970a341bb90057635380,createdAt:2019-12-10T13:00:58.616Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:2,slug:whatsapp-webhooks-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:5d9d9cce266531004a6bcbfd,createdAt:2019-10-09T08:39:42.078Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:3,slug:whatsapp-webhooks-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:60cca4ba9176d3002cb3d83a,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Postback Received,type:basic,slug:whatsapp-webhooks-postback-received,order:4,isReference:true,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:postback-received,createdAt:2021-06-18T13:50:50.009Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,isBodyEmpty:false,children:}}}},apiBaseUrl:/,baseUrl:/,search:{appId:T28YKFATPY,searchApiKey:NDZhOTVhMDMxNzgxMWQyYjdjMzM5MDMwOGU0ZDYzNGNjOTIyYjY5MWU1ODUwMmRhZDYwZGZjYTE2N2Y1ZWFjM3RhZ0ZpbHRlcnM9KHByb2plY3Q6NTg0YmQyOTYwOTEwNGQyMzAwN2Q5ZWM5KSwodmVyc2lvbjpub25lLHZlcnNpb246NTlmYzQyODAzY2Y3MTgwMDEwNjliOWFiKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ,indexName:readme_search_v2,projectsMeta:{modules:{reference:true,examples:true,docs:true,landing:true,suggested_edits:true,discuss:false,changelog:false,logs:false,custompages:false,tutorials:false,graphql:false},id:584bd29609104d23007d9ec9,name:Amio,subdomain:amio,subpath:,nav_names:{discuss:,docs:Documentation,reference:API Reference,changelog:,tutorials:,recipes:}},urlManagerOpts:{lang:en,parent:{childrenProjects:},project:{subdomain:amio},version:1.0}},changelogs:,discuss:,docsCategories:{_id:59fc42803cf718001069b92c,title:Introduction,createdAt:2017-05-11T08:09:08.020Z,from_sync:false,project:584bd29609104d23007d9ec9,order:0,reference:false,slug:test,version:59fc42803cf718001069b9ab,__v:0,isAPI:false,pages:{_id:59fc42803cf718001069b97d,parentDoc:null,sync_unique:,createdAt:2017-05-11T08:41:25.049Z,isReference:false,link_external:false,link_url:,title:Introduction,api:{params:,url:,method:get,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},auth:required},hidden:false,order:0,slug:amio-introduction,category:59fc42803cf718001069b92c,type:basic,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b99b,link_external:false,link_url:,category:59fc42803cf718001069b92c,isReference:false,type:basic,slug:getting-started,hidden:false,parentDoc:null,sync_unique:,api:{url:,method:get,results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:},order:1,title:Getting Started,createdAt:2017-05-30T08:43:04.631Z,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b97e,category:59fc42803cf718001069b92c,link_external:false,order:2,title:Channels,hidden:false,sync_unique:,type:basic,api:{auth:required,params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}}},parentDoc:null,slug:messaging-channels,createdAt:2017-05-11T08:59:44.010Z,isReference:false,link_url:,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b99a,parentDoc:null,hidden:false,link_url:,type:basic,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},order:3,slug:tooling,title:Tooling,createdAt:2017-05-25T17:04:52.908Z,isReference:false,link_external:false,category:59fc42803cf718001069b92c,sync_unique:,isBodyEmpty:false,children:{_id:5bdc409a6c0270004a84f609,category:59fc42803cf718001069b92c,parentDoc:59fc42803cf718001069b99a,createdAt:2018-11-02T12:18:34.806Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:postman,type:basic,title:Postman,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5bdad59a7ff77e001f39f0cc,category:59fc42803cf718001069b92c,parentDoc:59fc42803cf718001069b99a,createdAt:2018-11-01T10:29:46.060Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:ngrok,type:basic,title:Ngrok,isBodyEmpty:false,children:}},{_id:5b6ac8e8e7c35b0003e31e65,category:59fc42803cf718001069b92c,createdAt:2018-08-08T10:41:44.818Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:4,slug:miscellaneous,type:basic,title:Miscellaneous,parentDoc:null,isBodyEmpty:false,children:},{_id:62ff4289d45ed10091ecdb33,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:From first example to fully automated chat,icon:,type:basic,slug:first-intent,order:5,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-08-19T07:58:01.654Z,category:59fc42803cf718001069b92c,parentDoc:null,isBodyEmpty:false,children:{_id:6339a652abd8e10017d46e92,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Start your first conversation,icon:,type:basic,slug:start-your-first-conversation,order:0,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T14:55:14.693Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339a6f2b627c3006b99e35f,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Create and suggest intents,icon:,type:basic,slug:create-and-suggest-intents,order:1,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T14:57:54.647Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339acb98fa4d90073970b22,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Add more examples,icon:,type:basic,slug:create-answers-1,order:2,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T15:22:33.551Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339b0497fbbfd03b5920fec,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Conversation structure,icon:,type:basic,slug:conversation-structure,order:3,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T15:37:45.831Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339b1f13ccedc00a553c56b,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Conversation editor,icon:,type:basic,slug:conversation-editor,order:4,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T15:44:49.877Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,mdx:{},isBodyEmpty:false,children:},{_id:6339b48610c88f0513c96577,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Answer publishing,icon:,type:basic,slug:answer-publishing,order:5,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T15:55:50.005Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:6339b64acdba7a00998b99f8,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Operator status,icon:,type:basic,slug:operator-status,order:6,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-10-02T16:03:22.842Z,parentDoc:62ff4289d45ed10091ecdb33,category:59fc42803cf718001069b92c,isBodyEmpty:false,children:},{_id:64edfafafaac6c00205a5812,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:Chatbot context,icon:,type:basic,slug:chatbot-context,order:7,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:59fc42803cf718001069b92c,createdAt:2023-08-29T14:04:42.375Z,parentDoc:62ff4289d45ed10091ecdb33,mdx:{},isBodyEmpty:false,children:}}},{_id:67c87f5f8987170010065a43,title:Chatbot,slug:chatbot,order:1,reference:false,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,createdAt:2025-03-05T16:44:15.390Z,__v:0,pages:{_id:67c881198987170010066814,mdx:{},api:{method:get,url:,auth:required,params:},title:🛍️ Product Feeds: Best Practices,icon:,type:basic,slug:bot-product-feeds-best-practices,order:0,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:️-product-feeds-best-practices,category:67c87f5f8987170010065a43,createdAt:2025-03-05T16:51:37.900Z,parentDoc:null,isBodyEmpty:false,children:}},{_id:5c9b9f9ba1cc170039471288,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2019-03-27T16:06:51.263Z,order:2,slug:amio-chat-1,title:Amio Chat,__v:0,pages:{_id:5c9ba291bb4936000e74a1c0,createdAt:2019-03-27T16:19:29.132Z,category:5c9b9f9ba1cc170039471288,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:amio-chat,type:basic,title:Amio Chat,parentDoc:null,isBodyEmpty:false,children:},{_id:5ef07245ec4a5d001fa2c94d,api:{method:get,url:,auth:required,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},params:},title:Getting Started: Amio Web Chat,type:basic,slug:amio-chat-getting-started-web-chat,order:1,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,createdAt:2020-06-22T08:56:37.409Z,category:5c9b9f9ba1cc170039471288,parentDoc:null,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:{_id:5ef072f3b011fa0011834f28,api:{method:get,url:,auth:required,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},params:,examples:{codes:}},title:Connect Amio Chat,type:basic,slug:amio-chat-getting-started-web-chat-connect-amio-chat,order:0,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,parentDoc:5ef07245ec4a5d001fa2c94d,createdAt:2020-06-22T08:59:31.119Z,category:5c9b9f9ba1cc170039471288,previousSlug:,deprecated:false,icon:,mdx:{},isBodyEmpty:false,children:},{_id:5ef0bd902a613d00453aff82,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Receive message through Amio API,type:basic,slug:amio-chat-getting-started-web-chat-receive-message-through-amio-api,order:1,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,createdAt:2020-06-22T14:17:52.940Z,parentDoc:5ef07245ec4a5d001fa2c94d,category:5c9b9f9ba1cc170039471288,isBodyEmpty:false,children:},{_id:5ef0bb7b28d3ac001106329a,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Send message through Amio API,type:basic,slug:amio-chat-getting-started-web-chat-send-message-through-amio-api,order:2,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,createdAt:2020-06-22T14:08:59.668Z,parentDoc:5ef07245ec4a5d001fa2c94d,category:5c9b9f9ba1cc170039471288,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:61dd8a81744b220045a60317,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:API methods,type:basic,slug:amio-chat-api-methods,order:3,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:open-and-close-methods,createdAt:2022-01-11T13:47:45.464Z,parentDoc:5ef07245ec4a5d001fa2c94d,category:5c9b9f9ba1cc170039471288,icon:,mdx:{},isBodyEmpty:false,children:{_id:67ef97ea386fc6e2ccf80fe6,mdx:{},api:{method:get,url:,auth:required,params:},title:Theme properties,icon:,type:basic,slug:theme-properties,order:0,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:61dd8a81744b220045a60317,category:5c9b9f9ba1cc170039471288,createdAt:2025-04-04T08:27:22.440Z,isBodyEmpty:false,children:},{_id:6824bf6fcf59aa0030c39e0c,mdx:{},api:{method:get,url:,auth:required,params:},title:Text properties,icon:,type:basic,slug:text-properties,order:1,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:61dd8a81744b220045a60317,category:5c9b9f9ba1cc170039471288,createdAt:2025-05-14T16:06:07.050Z,isBodyEmpty:false,children:}}},{_id:68beea2f98707f91f249cda3,title:Getting Started: Mobile App,icon:,type:basic,slug:getting-started-mobile-app,mdx:{},category:5c9b9f9ba1cc170039471288,order:2,isReference:false,deprecated:false,api:{method:get,url:,auth:required,params:},hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2025-09-08T14:37:35.778Z,parentDoc:null,isBodyEmpty:false,children:},{_id:5c9ba3373c9f770051af8ec8,createdAt:2019-03-27T16:22:15.399Z,category:5c9b9f9ba1cc170039471288,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:amio-chat-getting-started-sdk,type:basic,title:Getting Started: SDK for Web,parentDoc:null,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:{_id:5ca4639d2b3bee00632c7887,createdAt:2019-04-03T07:41:17.217Z,category:5c9b9f9ba1cc170039471288,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:amio-chat-getting-started-sdk-connect-amio-chat,type:basic,title:Connect Amio Chat,parentDoc:5c9ba3373c9f770051af8ec8,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5ca4644ca7db9e0013384003,createdAt:2019-04-03T07:44:12.171Z,category:5c9b9f9ba1cc170039471288,parentDoc:5c9ba3373c9f770051af8ec8,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:amio-chat-getting-started-sdk-send-message-from-web,type:basic,title:Send message from Web,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5ca4646fee50aa001fed64cc,createdAt:2019-04-03T07:44:47.334Z,category:5c9b9f9ba1cc170039471288,parentDoc:5c9ba3373c9f770051af8ec8,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:amio-chat-getting-started-sdk-receive-message-on-web,type:basic,title:Receive message on Web,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5ca46e4e512269005c905171,createdAt:2019-04-03T08:26:54.214Z,category:5c9b9f9ba1cc170039471288,parentDoc:5c9ba3373c9f770051af8ec8,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:amio-chat-getting-started-sdk-send-message-through-amio-api,type:basic,title:Send message through Amio API,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5ca475ecb9ca760014d6a5cd,createdAt:2019-04-03T08:59:24.553Z,category:5c9b9f9ba1cc170039471288,parentDoc:5c9ba3373c9f770051af8ec8,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:4,slug:amio-chat-getting-started-sdk-receive-message-through-amio-api,type:basic,title:Receive message through Amio API,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:63c9c1a36d0a96006af37536,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Ticket Deflection,icon:,type:basic,slug:tisket-deflection,order:4,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:deflection,parentDoc:null,category:5c9b9f9ba1cc170039471288,createdAt:2023-01-19T22:18:11.121Z,mdx:{},isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b92d,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,createdAt:2017-05-11T09:01:24.683Z,order:3,slug:facebook-messenger,__v:0,reference:false,from_sync:false,title:Facebook Messenger,pages:{_id:59fc42803cf718001069b984,title:Facebook Messenger,isReference:false,order:0,slug:facebook-messenger,api:{url:,method:get,results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:},createdAt:2017-05-12T06:48:56.526Z,parentDoc:null,type:basic,sync_unique:,hidden:false,link_external:false,link_url:,category:59fc42803cf718001069b92d,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b989,type:basic,createdAt:2017-05-12T11:28:28.721Z,parentDoc:null,hidden:false,link_external:false,link_url:,sync_unique:,title:Getting Started,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required},category:59fc42803cf718001069b92d,slug:facebook-messenger-getting-started,isReference:false,order:1,isBodyEmpty:false,children:{_id:59fc42803cf718001069b980,isReference:false,slug:facebook-messenger-getting-started-prepare-facebook-page,order:0,type:basic,hidden:false,link_external:false,link_url:,parentDoc:59fc42803cf718001069b989,category:59fc42803cf718001069b92d,createdAt:2017-05-11T09:02:38.346Z,sync_unique:,api:{results:{codes:{status:200,language:json,code:{},name:},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get},title:Prepare Facebook Page,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b990,category:59fc42803cf718001069b92d,parentDoc:59fc42803cf718001069b989,slug:facebook-messenger-getting-started-connect-facebook-page,sync_unique:,api:{method:get,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},auth:required,params:,url:},createdAt:2017-05-25T09:01:38.419Z,isReference:false,type:basic,link_external:false,link_url:,order:1,title:Connect Facebook Page,hidden:false,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b992,hidden:false,isReference:false,title:Send Message,category:59fc42803cf718001069b92d,createdAt:2017-05-25T09:19:38.366Z,order:2,type:basic,link_url:,parentDoc:59fc42803cf718001069b989,sync_unique:,api:{method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:},link_external:false,slug:facebook-messenger-getting-started-send-message,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b991,createdAt:2017-05-25T09:05:11.542Z,hidden:false,slug:facebook-messenger-getting-started-receive-message,type:basic,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required},category:59fc42803cf718001069b92d,isReference:false,link_url:,parentDoc:59fc42803cf718001069b989,sync_unique:,link_external:false,order:3,title:Receive Message,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b97f,hidden:false,parentDoc:null,api:{auth:required,params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}}},category:59fc42803cf718001069b92d,createdAt:2017-05-11T09:01:50.889Z,link_url:,title:Entry Points,order:2,type:basic,isReference:false,link_external:false,slug:facebook-messenger-entry-points,sync_unique:,isBodyEmpty:false,children:{_id:59fc42803cf718001069b996,slug:facebook-messenger-entry-points-from-facebook,type:basic,createdAt:2017-05-25T13:13:33.724Z,hidden:false,parentDoc:59fc42803cf718001069b97f,isReference:false,link_external:false,sync_unique:,api:{results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},category:59fc42803cf718001069b92d,link_url:,order:0,title:From Facebook,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b999,createdAt:2017-05-25T13:22:18.867Z,link_external:false,title:Using Phone Number,sync_unique:,api:{method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:},category:59fc42803cf718001069b92d,isReference:false,hidden:false,link_url:,type:basic,order:1,parentDoc:59fc42803cf718001069b97f,slug:facebook-messenger-entry-points-using-phone-number,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b997,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},slug:facebook-messenger-entry-points-from-webpage,sync_unique:,type:basic,isReference:false,link_url:,category:59fc42803cf718001069b92d,createdAt:2017-05-25T13:13:50.010Z,hidden:false,order:2,link_external:false,parentDoc:59fc42803cf718001069b97f,title:From Webpage,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b998,link_external:false,link_url:,parentDoc:59fc42803cf718001069b97f,createdAt:2017-05-25T13:14:57.779Z,isReference:false,order:3,sync_unique:,title:From Messenger,type:basic,api:{url:,method:get,results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:},category:59fc42803cf718001069b92d,hidden:false,slug:facebook-messenger-entry-points-from-messenger,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b99d,category:59fc42803cf718001069b92d,parentDoc:59fc42803cf718001069b97f,createdAt:2017-06-26T08:38:20.835Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:4,slug:facebook-messenger-entry-points-offline,type:basic,title:Offline,isBodyEmpty:false,children:}},{_id:5b30f66ddf0e3b0003abb71d,category:59fc42803cf718001069b92d,createdAt:2018-06-25T14:04:29.472Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:tutorials,type:basic,title:Tutorials,parentDoc:null,isBodyEmpty:false,children:{_id:59fc42803cf718001069b9a3,category:59fc42803cf718001069b92d,parentDoc:5b30f66ddf0e3b0003abb71d,createdAt:2017-08-17T07:05:51.873Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:facebook-messenger-tutorials-custom-facebook-app,type:basic,title:Custom Facebook App,isBodyEmpty:false,children:},{_id:5ba2174f4f89f700039d8ed8,category:59fc42803cf718001069b92d,parentDoc:5b30f66ddf0e3b0003abb71d,createdAt:2018-09-19T09:30:55.742Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:facebook-messenger-tutorials-subscription-messages,type:basic,title:Subscription Messages,isBodyEmpty:false,children:}},{_id:5df2013fd20ce402cd372be5,category:59fc42803cf718001069b92d,createdAt:2019-12-12T08:49:59.989Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:4,slug:facebook-messenger-policy,type:basic,title:Policy,parentDoc:null,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b931,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,from_sync:false,__v:0,project:584bd29609104d23007d9ec9,createdAt:2017-05-11T09:43:28.314Z,order:4,slug:mobile,title:Mobile (SMS),pages:{_id:59fc42803cf718001069b987,type:basic,hidden:false,slug:mobile,createdAt:2017-05-12T06:50:45.262Z,order:0,sync_unique:,category:59fc42803cf718001069b931,link_url:,parentDoc:null,title:Mobile,api:{method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:},isReference:false,link_external:false,isBodyEmpty:false,children:},{_id:5b29128d94e1f7000317fdb9,category:59fc42803cf718001069b931,createdAt:2018-06-19T14:26:21.474Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:mobile-getting-started,type:basic,title:Getting Started,parentDoc:null,isBodyEmpty:false,children:{_id:5b29133df11cd000039cae4f,category:59fc42803cf718001069b931,parentDoc:5b29128d94e1f7000317fdb9,createdAt:2018-06-19T14:29:17.081Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:mobile-messagebird,type:basic,title:MessageBird,isBodyEmpty:false,children:},{_id:5b2a343d6f58a00003e5d30c,category:59fc42803cf718001069b931,parentDoc:5b29128d94e1f7000317fdb9,createdAt:2018-06-20T11:02:21.316Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:mobile-send-message,type:basic,title:Send Message,isBodyEmpty:false,children:},{_id:5b47105b3d4a9e00037896af,category:59fc42803cf718001069b931,parentDoc:5b29128d94e1f7000317fdb9,createdAt:2018-07-12T08:24:59.858Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:mobile-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:}}},{_id:5d569fa6251176006d5c0d2b,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2019-08-16T12:20:54.310Z,order:5,slug:rcs-business-messages,title:RCS Business Messages,__v:0,pages:{_id:5d569fcbdb6b9500441edf54,createdAt:2019-08-16T12:21:31.827Z,category:5d569fa6251176006d5c0d2b,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:rbm-rcs-business-messages,type:basic,title:RCS Business Messages,parentDoc:null,isBodyEmpty:false,children:},{_id:5d56a851f1a7b3002df9de5e,createdAt:2019-08-16T12:57:53.049Z,category:5d569fa6251176006d5c0d2b,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:rbm-getting-started,type:basic,title:Getting Started,parentDoc:null,isBodyEmpty:false,children:{_id:5d56ae5c26dd7d0043584f1a,createdAt:2019-08-16T13:23:40.604Z,category:5d569fa6251176006d5c0d2b,parentDoc:5d56a851f1a7b3002df9de5e,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:rbm-getting-started-create-agent,type:basic,title:Create RBM Channel,isBodyEmpty:false,children:},{_id:5d5967529465a2004afb6958,createdAt:2019-08-18T14:57:22.104Z,category:5d569fa6251176006d5c0d2b,parentDoc:5d56a851f1a7b3002df9de5e,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:rbm-getting-started-send-message,type:basic,title:Send Message,isBodyEmpty:false,children:},{_id:5d5a63a70810f10050791cf1,createdAt:2019-08-19T08:53:59.885Z,category:5d569fa6251176006d5c0d2b,parentDoc:5d56a851f1a7b3002df9de5e,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:rbm-getting-started-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:}},{_id:5d667bc01c274d005c0ba173,createdAt:2019-08-28T13:04:00.907Z,category:5d569fa6251176006d5c0d2b,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:rbm-launching-the-agent,type:basic,title:Launching the Agent,parentDoc:null,isBodyEmpty:false,children:},{_id:5d5913328a3868001fbd09c4,createdAt:2019-08-18T08:58:26.996Z,category:5d569fa6251176006d5c0d2b,parentDoc:null,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:rbm-register-test-device,type:basic,title:Register Test Device,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:5d2c76b7059ba7014799b44d,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2019-07-15T12:51:03.724Z,order:6,slug:telegram-1,title:Telegram,__v:0,pages:{_id:5d2c76cf4c60cf004e5e8789,createdAt:2019-07-15T12:51:27.102Z,category:5d2c76b7059ba7014799b44d,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:telegram,type:basic,title:Telegram,parentDoc:null,isBodyEmpty:false,children:},{_id:5d2c7ce5be6dfb003c750f3c,createdAt:2019-07-15T13:17:25.962Z,category:5d2c76b7059ba7014799b44d,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:telegram-getting-started,type:basic,title:Getting Started,parentDoc:null,isBodyEmpty:false,children:{_id:5d2c7f438b3baf00119f57a2,createdAt:2019-07-15T13:27:31.829Z,category:5d2c76b7059ba7014799b44d,parentDoc:5d2c7ce5be6dfb003c750f3c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:telegram-getting-started-connect-telegram-bot,type:basic,title:Connect Telegram Bot,isBodyEmpty:false,children:},{_id:5d2c87ea4c49ab0073759a53,createdAt:2019-07-15T14:04:26.792Z,category:5d2c76b7059ba7014799b44d,parentDoc:5d2c7ce5be6dfb003c750f3c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:telegram-getting-started-send-message,type:basic,title:Send Message,isBodyEmpty:false,children:},{_id:5d2c8468c3634f002c896e26,createdAt:2019-07-15T13:49:28.717Z,category:5d2c76b7059ba7014799b44d,parentDoc:5d2c7ce5be6dfb003c750f3c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:telegram-getting-started-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:}},{_id:5d2c89e5382ec5001e455fc0,createdAt:2019-07-15T14:12:53.635Z,category:5d2c76b7059ba7014799b44d,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:telegram-entry-points,type:basic,title:Entry Points,parentDoc:null,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b92e,reference:false,from_sync:false,__v:0,project:584bd29609104d23007d9ec9,isAPI:false,createdAt:2017-05-11T09:41:01.249Z,order:7,slug:viber-1,title:Viber,version:59fc42803cf718001069b9ab,pages:{_id:59fc42803cf718001069b985,slug:viber,api:{auth:required,params:,url:,method:get,results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}}},createdAt:2017-05-12T06:49:40.310Z,isReference:false,type:basic,category:59fc42803cf718001069b92e,link_url:,order:0,title:Viber,hidden:false,link_external:false,parentDoc:null,sync_unique:,isBodyEmpty:false,children:},{_id:5a55f939d0cb660012505f32,category:59fc42803cf718001069b92e,createdAt:2018-01-10T11:30:01.635Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:viber-getting-started-viber-bot,type:basic,title:Getting Started - Viber Bot,parentDoc:null,isBodyEmpty:false,children:{_id:5b6c5a8ebba1100003ff524c,category:59fc42803cf718001069b92e,parentDoc:5a55f939d0cb660012505f32,createdAt:2018-08-09T15:15:26.147Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:viber-getting-started-viber-bot-connect-viber-bot-account,type:basic,title:Connect Viber Bot Account,isBodyEmpty:false,children:},{_id:5a58bd262e799c003047b583,category:59fc42803cf718001069b92e,parentDoc:5a55f939d0cb660012505f32,createdAt:2018-01-12T13:50:30.366Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:viber-getting-started-viber-bot-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:},{_id:5a58c00c086a05001c431f6c,category:59fc42803cf718001069b92e,parentDoc:5a55f939d0cb660012505f32,createdAt:2018-01-12T14:02:52.235Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:viber-getting-started-viber-bot-send-message,type:basic,title:Send Message,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:5b6d837a73acbe000364a3d0,category:59fc42803cf718001069b92e,createdAt:2018-08-10T12:22:18.180Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:viber-getting-started-viber-business-messages,type:basic,title:Getting Started - Viber Business Messages,parentDoc:null,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:{_id:5b71909a6711770003dbd1d0,category:59fc42803cf718001069b92e,parentDoc:5b6d837a73acbe000364a3d0,createdAt:2018-08-13T14:07:22.052Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:viber-getting-started-viber-business-messages-connect,type:basic,title:Connect Viber Business Messages,isBodyEmpty:false,children:},{_id:5b6d83c6ebb22e0003051795,category:59fc42803cf718001069b92e,parentDoc:5b6d837a73acbe000364a3d0,createdAt:2018-08-10T12:23:34.410Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:viber-getting-started-viber-business-messages-send-message,type:basic,title:Send Message,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b8fd0803b94c30003bc9fd2,category:59fc42803cf718001069b92e,parentDoc:5b6d837a73acbe000364a3d0,createdAt:2018-09-05T12:48:00.567Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:viber-getting-started-viber-business-messages-receive-message,type:basic,title:Receive Message,isBodyEmpty:false,children:}},{_id:5a58a28afe845d001253ea97,category:59fc42803cf718001069b92e,createdAt:2018-01-12T11:56:58.937Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:viber-entry-points,type:basic,title:Entry Points,parentDoc:null,isBodyEmpty:false,children:{_id:5a58a36eec04490032eb9cfb,category:59fc42803cf718001069b92e,parentDoc:5a58a28afe845d001253ea97,createdAt:2018-01-12T12:00:46.135Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:false,order:0,slug:viber-entry-points-bot-links,type:basic,title:Viber Bot Links,deprecated:false,icon:,previousSlug:,isBodyEmpty:false,children:},{_id:5a58b113ec04490032eb9eaa,category:59fc42803cf718001069b92e,parentDoc:5a58a28afe845d001253ea97,createdAt:2018-01-12T12:58:59.391Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:viber-entry-points-using-phone-number,type:basic,title:Using Phone Number,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}}},{_id:5d93554cc986080018662575,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2019-10-01T13:31:56.356Z,order:8,slug:whatsapp-2,title:WhatsApp,__v:0,pages:{_id:5d93556a85a9c8003168b443,createdAt:2019-10-01T13:32:26.953Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:whatsapp,type:basic,title:WhatsApp,parentDoc:null,isBodyEmpty:false,children:{_id:5da03a9df28e2c00257cb792,createdAt:2019-10-11T08:17:33.184Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:whatsapp-business-account,type:basic,title:WhatsApp Business Account,parentDoc:5d93556a85a9c8003168b443,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5da0351f69a3790071cba2c9,createdAt:2019-10-11T07:54:07.659Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:1,slug:whatsapp-eligible-phone-numbers,type:basic,title:Eligible Phone Numbers,parentDoc:5d93556a85a9c8003168b443,isBodyEmpty:false,children:},{_id:63b295f8c29e5f004c06f1e2,api:{method:get,url:,auth:required,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},params:,examples:{codes:}},title:Account Registration,icon:,type:basic,slug:business-account-registration-cloud-api,order:2,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d93556a85a9c8003168b443,category:5d93554cc986080018662575,createdAt:2023-01-02T08:29:44.648Z,isBodyEmpty:false,children:},{_id:60ffc3cd950fca002a73d222,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Porting a Phone Number,type:basic,slug:porting-a-phone-number,order:4,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2021-07-27T08:29:01.221Z,parentDoc:5d93556a85a9c8003168b443,category:5d93554cc986080018662575,isBodyEmpty:false,children:},{_id:61324d2c05fce00062b701ac,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:WhatsApp Pricing 💲,type:basic,slug:whatsapp-pricing,order:5,isReference:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2021-09-03T16:28:28.033Z,parentDoc:5d93556a85a9c8003168b443,category:5d93554cc986080018662575,isBodyEmpty:false,children:},{_id:682ddfe30928bf0018b1de66,mdx:{},api:{method:get,url:,auth:required,params:},title:Migration: From API to app,icon:,type:basic,slug:from-api-to-app,order:7,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d93556a85a9c8003168b443,category:5d93554cc986080018662575,createdAt:2025-05-21T14:14:59.600Z,isBodyEmpty:false,children:}},{_id:5da04e47c6eb85006da40474,createdAt:2019-10-11T09:41:27.645Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:2,slug:whatsapp-entry-points,type:basic,title:Entry Points,parentDoc:null,isBodyEmpty:false,children:{_id:5da052c816bc3c003a92e80f,createdAt:2019-10-11T10:00:40.999Z,parentDoc:5da04e47c6eb85006da40474,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:0,slug:opt-in-for-whatsapp,type:basic,title:Opt-in for WhatsApp,isBodyEmpty:false,children:}},{_id:5da07960e15930004889acfd,createdAt:2019-10-11T12:45:20.275Z,category:5d93554cc986080018662575,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:false,order:3,slug:whatsapp-policy,type:basic,title:Policy,parentDoc:null,isBodyEmpty:false,children:}},{_id:5bd9acb4608df7005518e47f,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:false,createdAt:2018-10-31T13:23:00.786Z,order:9,slug:integrations,title:Integrations - Help Desks,__v:0,pages:{_id:63203f59ef63830071441fa0,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Daktela - Webchat,icon:,type:basic,slug:daktela,order:0,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2022-09-13T08:29:13.098Z,category:5bd9acb4608df7005518e47f,parentDoc:null,isBodyEmpty:false,children:},{_id:644b4a8b517cfd000b801142,api:{method:get,url:,auth:required,params:},title:Daktela - Email,icon:,type:basic,slug:daktela-email,order:1,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:5bd9acb4608df7005518e47f,createdAt:2023-04-28T04:24:43.889Z,parentDoc:null,isBodyEmpty:false,children:},{_id:63aac9855315f0004b0223b0,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:FreshWorks (FreshChat),icon:,type:basic,slug:freshworks,order:2,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:5bd9acb4608df7005518e47f,createdAt:2022-12-27T10:31:33.384Z,parentDoc:null,mdx:{},isBodyEmpty:false,children:},{_id:65193cd0a20b64003beca5ef,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:Salesforce,icon:,type:basic,slug:salesforce-webchat,order:3,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:5bd9acb4608df7005518e47f,createdAt:2023-10-01T09:33:04.116Z,parentDoc:null,isBodyEmpty:false,children:},{_id:6656ea457568a30018e5bd0b,api:{method:get,url:,auth:required,params:},title:Front,icon:,type:basic,slug:front,order:4,isReference:false,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,category:5bd9acb4608df7005518e47f,createdAt:2024-05-29T08:41:41.102Z,parentDoc:null,isBodyEmpty:false,children:}},{_id:68c16049f45d950727146b92,title:Integrations - E-commerce Platforms,version:59fc42803cf718001069b9ab,project:584bd29609104d23007d9ec9,slug:integrations-,order:10,reference:false,createdAt:2025-09-10T11:26:01.343Z,__v:0,pages:{_id:68c160c7eb2795f82c63317e,title:Shopify,icon:,type:basic,slug:shopify,mdx:{},category:68c16049f45d950727146b92,order:999,isReference:false,deprecated:false,api:{method:get,url:,auth:required,params:},hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,createdAt:2025-09-10T11:28:07.156Z,isBodyEmpty:false,children:}},refCategories:{_id:59fc42803cf718001069b924,slug:api-endpoints,sync:{url:,isSync:false},title:Introduction,project:584bd29609104d23007d9ec9,createdAt:2016-12-10T11:20:37.914Z,from_sync:false,order:0,reference:true,version:59fc42803cf718001069b9ab,__v:0,pages:{_id:59fc42803cf718001069b93c,createdAt:2016-12-21T07:47:16.515Z,isReference:true,sync_unique:,parentDoc:null,type:basic,category:59fc42803cf718001069b924,link_external:false,order:0,link_url:,slug:introduction,title:Introduction,api:{settings:,url:,apiSetting:null,auth:required,params:,results:{codes:{status:200,language:json,code:{},name:},{language:json,code:{},name:,status:400}},method:get},hidden:false,previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b938,link_external:false,order:1,type:basic,createdAt:2016-12-19T09:52:06.749Z,hidden:false,link_url:,parentDoc:null,sync_unique:,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,method:get,params:},slug:authentication,title:Authentication,category:59fc42803cf718001069b924,isReference:true,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b93d,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,method:get,params:},link_url:,slug:requests,type:basic,category:59fc42803cf718001069b924,createdAt:2016-12-21T08:57:31.682Z,sync_unique:,isReference:true,link_external:false,order:2,hidden:false,parentDoc:null,title:Requests,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b93e,sync_unique:,type:basic,slug:responses,category:59fc42803cf718001069b924,order:3,parentDoc:null,link_url:,title:Responses,api:{url:,auth:required,method:get,params:,results:{codes:{code:{},name:,status:200,language:json},{status:400,language:json,code:{},name:}},settings:},createdAt:2016-12-21T08:57:38.910Z,hidden:false,link_external:false,isReference:true,isBodyEmpty:false,children:{_id:59fc42803cf718001069b94f,hidden:false,link_external:false,slug:errors,api:{auth:required,method:get,params:,results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},settings:,url:},createdAt:2017-01-04T13:34:10.863Z,order:0,sync_unique:,category:59fc42803cf718001069b924,link_url:,parentDoc:59fc42803cf718001069b93e,isReference:true,title:Errors,type:basic,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b93f,type:basic,api:{auth:required,method:get,params:,results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,url:},category:59fc42803cf718001069b924,link_external:false,order:4,title:Pagination,link_url:,isReference:true,createdAt:2016-12-21T09:40:51.426Z,hidden:false,parentDoc:null,slug:pagination,sync_unique:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b971,category:59fc42803cf718001069b924,createdAt:2017-04-07T12:43:04.358Z,isReference:true,sync_unique:,link_url:,slug:rate-limiting,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{name:,status:400,language:json,code:{}}},auth:required},hidden:false,link_external:false,type:basic,order:5,parentDoc:null,title:Rate Limiting,isBodyEmpty:false,children:},{_id:5c3f47308fd6fb0038787cbf,category:59fc42803cf718001069b924,createdAt:2019-01-16T15:01:04.137Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:6,slug:locale,type:basic,title:Locale,parentDoc:null,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b925,slug:webhooks,version:59fc42803cf718001069b9ab,__v:0,createdAt:2016-12-10T11:20:48.353Z,reference:true,sync:{url:,isSync:false},title:API Reference,from_sync:false,order:1,project:584bd29609104d23007d9ec9,pages:{_id:59fc42803cf718001069b940,hidden:false,slug:messages,type:basic,api:{settings:,url:,auth:required,method:get,params:,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}}},createdAt:2016-12-21T11:26:20.166Z,category:59fc42803cf718001069b925,isReference:true,order:0,parentDoc:null,title:Messages,sync_unique:,link_external:false,link_url:,isBodyEmpty:false,children:{_id:5a706c60b3c9580024d1a257,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b940,createdAt:2018-01-30T13:00:16.087Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \payload\: \{{CONTENT_TYPE}}\,\n \type\: \{{CONTENT_PAYLOAD}}\\n }\n }\n,language:json,status:200}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a706ff82c5b7f007bf7fc66},{name:contact_id,type:string,enumValues:,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5a706ff82c5b7f007bf7fc65},{name:max,type:int,enumValues:,default:10,desc:Maximum number of messages to be listed. Values larger than 100 are accepted but the list will never contain more than 100 messages. (default is 10),required:false,in:query,ref:,_id:60c899b9ebf23301cc344ce8},{name:offset,type:int,enumValues:,default:0,desc:Offset of the starting position in the message list.,required:false,in:query,ref:,_id:60c899b9ebf23301cc344ce7},{name:since,type:string,enumValues:,default:,desc:Allows filtering messages by date. Must be in ISO 8601 format.,required:false,in:query,ref:,_id:60c899b9ebf23301cc344ce6},{name:before,type:string,enumValues:,default:,desc:Allows filtering messages by date. Must be in ISO 8601 format.,required:false,in:query,ref:,_id:60c899b9ebf23301cc344ce5},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get,apiSetting:5d8ac5fa5478da001f7f3533,examples:{codes:{code:curl --request GET \\\n --url https://api.amio.io/v1/channels/{{channel_id}}/contacts/{{contact_id}}/messages,language:curl}}},isReference:true,order:0,slug:messages-list-messages,type:endpoint,title:List Messages,previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b93b,parentDoc:59fc42803cf718001069b940,api:{url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \{{CONTENT_TYPE}}\,\n \payload\: \{{CONTENT_PAYLOAD}}\\n }\n}}},method:post,params:{name:channel.id,type:string,default:,desc:Id of the channel you wish to send the message to. You can get channel id in administration.,required:true,in:body,ref:,_id:586a5a05e272d81900733a6c},{name:contact.id,type:string,default:,desc:Id of the contact you wish to send the message to. There are different ways how to a contact (they are typically specific to a channel type), see Platform Specific Requests(ref:messages-platform-specific-requests) for more details.,required:true,in:body,ref:,_id:58d271a5eb285919003337c1},{name:content.type,type:string,default:,desc:Different types of the content can be sent: `text`, `file`, `audio`, `video` and `image`, `structure`, etc. See Platform Specific Requests(ref:messages-platform-specific-requests) for more detail.,required:true,in:body,ref:,_id:586a5aa679f1b92500e92594},{name:content.payload,type:string,default:,desc:Payload is specific to message type. Different message types are documented in Platform Specific Requests(ref:messages-platform-specific-requests).,required:true,in:body,ref:,_id:586a5aa679f1b92500e92593},{name:metadata,type:object,default:,desc:Metadata(ref:messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a16a555fff719001ee14657},results:{codes:{status:201,language:json,code:{\n \id\: \{{MESSAGE_ID}}\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \{{CONTENT_TYPE}}\,\n \payload\: \{{CONTENT_PAYLOAD}}\\n }\n},name:}},settings:,apiSetting:5d8ac5fa5478da001f7f3533},category:59fc42803cf718001069b925,createdAt:2016-12-20T10:29:34.787Z,hidden:false,link_url:,slug:messages-send-message,sync_unique:,order:1,title:Send Message,type:endpoint,isReference:true,link_external:false,previousSlug:,isBodyEmpty:false,children:},{_id:5a16a578f7b5a0001e036c01,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b940,createdAt:2017-11-23T10:39:52.356Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:2,slug:messages-metadata,type:basic,title:Metadata,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:5a296fa7842c120012bd7ed3,category:59fc42803cf718001069b925,createdAt:2017-12-07T16:43:19.147Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:notifications,type:basic,title:Notifications,parentDoc:null,isBodyEmpty:false,children:{_id:5a297133ec2b8400128ed5e0,category:59fc42803cf718001069b925,parentDoc:5a296fa7842c120012bd7ed3,createdAt:2017-12-07T16:49:55.461Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,settings:,results:{codes:{status:200,language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \type\: \{{NOTIFICATION_TYPE}}\\n},name:}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\,\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \type\: \{{NOTIFICATION_TYPE}}\\n},language:json}},auth:required,params:{_id:586a5a05e272d81900733a6c,ref:,in:body,required:true,desc:Id of the channel you wish to send the notification to. You can get channel id in administration.,default:,type:string,name:channel.id},{_id:58d271a5eb285919003337c1,ref:,in:body,required:true,desc:Id of the contact you wish to send the notification to. There are different ways how to a contact (they are typically specific to a channel type), see Platform Specific Requests(ref:messages-platform-specific-requests) for more details.,default:,type:string,name:contact.id},{_id:586a5aa679f1b92500e92594,ref:,in:body,required:true,desc:Type specifies the notification to be sent they are different in each platform, see Platform Specific Requests(ref:notifications-platform-specific-requests).,default:,type:string,name:type},url:/v1/notifications,method:post},isReference:true,order:0,slug:notifications-send-notification,type:endpoint,title:Send Notification,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b957,hidden:false,slug:channels,type:basic,createdAt:2017-03-22T11:31:32.959Z,isReference:true,link_url:,parentDoc:null,sync_unique:,title:Channels,category:59fc42803cf718001069b925,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required},order:2,link_external:false,isBodyEmpty:false,children:{_id:59fc42803cf718001069b9aa,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b957,createdAt:2017-10-27T12:47:49.173Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,results:{codes:{name:OK,code:\n {\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n }\n\n,language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1c3c73c73b44001ed598e2,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b957,createdAt:2017-11-27T16:25:23.356Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n},language:json,status:200}},apiSetting:5d8ac5fa5478da001f7f3533,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1c3c73c73b44001ed598e3},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1c3f2d9b53b8001e82bf86,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b957,createdAt:2017-11-27T16:37:01.194Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n }\n},language:json,status:201}},examples:{codes:{language:json,code:{\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\ \n }\n}}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type specifying the underlying platform: `amio_chat`, `email`, `facebook_messenger`, `mobile`, `rbm`, `telegram`, `viber`, `viber_business_messages`, `whatsapp`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be automatically filled with an account name of underlying platform.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Allowed values depends on the channel type.,required:false,in:body,ref:,_id:5d5c22d5f20ff50052c03fc6},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3bdac9c7824200187266a4},url:/v1/channels,method:post},isReference:true,order:2,slug:channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1c45f769b8660032b4e125,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b957,createdAt:2017-11-27T17:05:59.462Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \0jOPqX32hDS5AGKOcGRH\\n }\n}}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \{{CHANNEL_TYPE}}\,\n \name\: \Some Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \0jOPqX32hDS5AGKOcGRH\,\n \ssl_verification\: true\n }\n},name:OK}},apiSetting:5d8ac5fa5478da001f7f3533,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1c4646c73b44001ed59a0e},{name:name,type:string,enumValues:,default:,desc:Name of the channel.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Allowed values depends on the channel type.,required:false,in:body,ref:,_id:5d5c217bb190700116512f37},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3bd596a148d100323c6599},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b95a,createdAt:2017-03-23T08:13:05.620Z,link_external:false,slug:channels-delete-channel,sync_unique:,link_url:,parentDoc:59fc42803cf718001069b957,type:endpoint,category:59fc42803cf718001069b925,hidden:false,order:4,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},url:/v1/channels/{channel_id},auth:required,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},method:delete,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},apiSetting:5d8ac5fa5478da001f7f3533},isReference:true,title:Delete Channel,isBodyEmpty:true,children:}},{_id:59fc42803cf718001069b9a7,category:59fc42803cf718001069b925,createdAt:2017-10-27T11:45:06.616Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:59fc42803cf718001069b9a8,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b9a7,createdAt:2017-10-27T11:56:57.933Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5a0aa45d2aad4d001ad60ccf,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b9a7,createdAt:2017-11-14T08:07:57.994Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\\n},name:OK}},apiSetting:5d8ac5fa5478da001f7f3533,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:contacts-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b9a9,category:59fc42803cf718001069b925,parentDoc:59fc42803cf718001069b9a7,createdAt:2017-10-27T12:20:40.429Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac5fa5478da001f7f3533,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:false,children:}},{_id:5a2a68b888574d001e9932f1,category:59fc42803cf718001069b925,createdAt:2017-12-08T10:26:00.623Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:settings,type:basic,title:Settings,parentDoc:null,isBodyEmpty:false,children:{_id:5a2a6e8ee25025003c5827a4,category:59fc42803cf718001069b925,parentDoc:5a2a68b888574d001e9932f1,createdAt:2017-12-08T10:50:54.887Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/settings,language:curl}},results:{codes:{status:200,language:json,code:{\n {{PLATFORM_SPECIFIC_SETTINGS}}\n},name:OK}},apiSetting:5d8ac5fa5478da001f7f3533,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:get},isReference:true,order:0,slug:settings-get-settings,type:endpoint,title:Get Settings,isBodyEmpty:true,children:},{_id:5a2a6c60bb0df5001c86d470,category:59fc42803cf718001069b925,parentDoc:5a2a68b888574d001e9932f1,createdAt:2017-12-08T10:41:36.592Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:{\n {{PLATFORM_SPECIFIC_SETTINGS}}\n},language:json,status:200},{name:,code:{},language:json,status:400}},auth:required,params:{_id:5a2a6da288574d001e993315,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:patch,apiSetting:5d8ac5fa5478da001f7f3533,examples:{codes:{code:{\n {{PLATFORM_SPECIFIC_SETTINGS}}\n},language:json}}},isReference:true,order:1,slug:settings-update-settings,type:endpoint,title:Update Settings,isBodyEmpty:true,children:}}},{_id:59fc42803cf718001069b928,slug:webhooks-1,project:584bd29609104d23007d9ec9,sync:{isSync:false,url:},reference:true,createdAt:2016-12-21T08:50:34.879Z,from_sync:false,version:59fc42803cf718001069b9ab,order:2,title:Webhooks,__v:0,pages:{_id:59fc42803cf718001069b935,hidden:false,sync_unique:,category:59fc42803cf718001069b928,parentDoc:null,isReference:true,order:0,slug:webhooks,type:basic,createdAt:2016-12-10T11:26:37.307Z,api:{examples:{codes:{language:text,code:// asd fdsalk fj;ldsa jfldsaf}},method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:/:version/m,auth:required},link_external:false,link_url:,title:Webhooks,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b941,createdAt:2016-12-21T11:45:11.712Z,link_external:false,order:1,category:59fc42803cf718001069b928,link_url:,parentDoc:null,sync_unique:,api:{auth:required,method:get,params:,results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},settings:,url:},isReference:true,slug:events,type:basic,title:Events,hidden:false,isBodyEmpty:false,children:{_id:59fc42803cf718001069b944,parentDoc:59fc42803cf718001069b941,createdAt:2016-12-21T12:48:28.345Z,isReference:true,link_url:,slug:events-message-received,api:{params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,method:get,examples:{codes:}},category:59fc42803cf718001069b928,sync_unique:,type:basic,link_external:false,title:Message Received,hidden:false,order:0,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42bf77dc0a0010000c1a,category:59fc42803cf718001069b928,parentDoc:59fc42803cf718001069b941,createdAt:2017-11-03T10:19:43.341Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:events-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5b1008cc4b213d0003829340,category:59fc42803cf718001069b928,parentDoc:59fc42803cf718001069b941,createdAt:2018-05-31T14:38:04.423Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:events-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:59fc4ebf3cf718001069baab,category:59fc42803cf718001069b928,parentDoc:59fc42803cf718001069b941,createdAt:2017-11-03T11:10:55.888Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:3,slug:events-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b955,createdAt:2017-03-06T19:11:02.320Z,hidden:false,link_external:false,link_url:,api:{params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,examples:{codes:}},title:Message Echo,slug:events-message-echo,sync_unique:,type:basic,category:59fc42803cf718001069b928,isReference:true,order:4,parentDoc:59fc42803cf718001069b941,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b94d,sync_unique:,isReference:true,link_url:,order:5,title:Channel Events,category:59fc42803cf718001069b928,hidden:false,createdAt:2017-01-02T15:13:51.591Z,link_external:false,parentDoc:59fc42803cf718001069b941,slug:events-channel-events,api:{auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:},type:basic,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b942,category:59fc42803cf718001069b928,isReference:true,link_url:,parentDoc:null,slug:security,api:{method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:,auth:required},createdAt:2016-12-21T11:45:32.635Z,hidden:false,link_external:false,order:2,sync_unique:,title:Security,type:basic,isBodyEmpty:false,children:}},{_id:5c9b6d0ba42eb00024b4af2c,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2019-03-27T12:31:07.549Z,order:3,slug:amio-chat,title:Amio Chat,__v:0,pages:{_id:5c9b6d2fe5e6e6001e15ee6b,createdAt:2019-03-27T12:31:43.784Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-amio-chat,type:basic,title:Amio Chat,parentDoc:null,isBodyEmpty:false,children:},{_id:5c9b6ea5bb4936000e749905,createdAt:2019-03-27T12:37:57.751Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:amio-chat-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5c9b6fc75302ae00431f45ad,createdAt:2019-03-27T12:42:47.660Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b6ea5bb4936000e749905,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331248741/contacts/6456078781510715474/messages,language:curl}},apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{name:,code:\n {\n \id\: \6456078996108099701\,\n \direction\: \sent\,\n \sent\: \2019-03-27T13:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331248741\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n }\n,language:json,status:200}},auth:required,params:{_id:5a706ff82c5b7f007bf7fc66,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a706ff82c5b7f007bf7fc65,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:amio-chat-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:false,children:},{_id:5c9b72796cd20e00141e4209,createdAt:2019-03-27T12:54:17.922Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b6ea5bb4936000e749905,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108099701\,\n \channel\: {\n \id\: \6456078759331248741\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:null}},examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331248741\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},settings:,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 1000 characters.,default:,type:string,name:content.payload},{_id:5e42679eee3fb80012cea750,ref:,in:body,required:false,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5e4268663f2716002a195e02,ref:,in:body,required:false,desc:Metadata(ref:amio-chat-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:1,slug:amio-chat-messages-text,type:endpoint,title:Text,isBodyEmpty:true,children:},{_id:5c9b7b19065d190063a4a0eb,createdAt:2019-03-27T13:31:05.011Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b6ea5bb4936000e749905,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5e426a35dd81f5001b88b66e,settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108099701\,\n \channel\: {\n \id\: \6456078759331248741\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},name:}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331248741\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:content.payload.url},{_id:5e4267fc21a9040154db2bf6,ref:,in:body,required:false,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5e42684b5e1c780019935aa0,ref:,in:body,required:false,desc:Metadata(ref:amio-chat-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages/,method:post},isReference:true,order:3,slug:amio-chat-messages-image,type:endpoint,title:Image,isBodyEmpty:true,children:},{_id:5e426fd5d6f538004f2a2fda,parentDoc:5c9b6ea5bb4936000e749905,category:5c9b6d0ba42eb00024b4af2c,createdAt:2020-02-11T01:14:52.039Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5e426de8bedf32005fb53c27,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.title,type:string,enumValues:,default:,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`. You can also omit the title attribute and use only `text` and `buttons` attributes.,required:false,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. **Max size** 80 characters. However, you can use **up to 640 characters** if you use text with buttons only.,required:false,in:body,ref:,_id:585b96556399952d00e0ac38},{name:content.payload.image_url,type:string,enumValues:,default:,desc:Url of an image to be displayed. Image ratio is 1.91:1.,required:false,in:body,ref:,_id:585b96556399952d00e0ac37},{name:content.payload.item_url,type:string,enumValues:,default:,desc:Url which is opened when the message is tapped.,required:false,in:body,ref:,_id:585b96556399952d00e0ac36},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:false,in:body,ref:,_id:585b96556399952d00e0ac35},{name:content.quick_replies,type:object,enumValues:,default:,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,required:false,in:body,ref:,_id:5e427056bedf32005fb53c4d},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:amio-chat-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a58e527791cac001c857652},url:/v1/messages,method:post},isReference:true,order:4,slug:amio-chat-messages-structure,type:endpoint,title:Structure,deprecated:false,icon:,previousSlug:,isBodyEmpty:false,children:},{_id:5e42712463f8090073f32c02,parentDoc:5c9b6ea5bb4936000e749905,category:5c9b6d0ba42eb00024b4af2c,createdAt:2020-02-11T01:14:50.716Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5e4270a063f8090073f32bfa,settings:,results:{codes:{name:,status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger with Coleslaw salad\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n}}},examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger with Coleslaw salad\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n}}},auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.title,type:string,enumValues:,default:,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`.,required:true,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. **Max size** 80 characters.,required:false,in:body,ref:,_id:585b96556399952d00e0ac38},{name:content.payload.image_url,type:string,enumValues:,default:,desc:Url of an image to be displayed. Image ratio is 1.91:1.,required:false,in:body,ref:,_id:585b96556399952d00e0ac37},{name:content.payload.item_url,type:string,enumValues:,default:,desc:Url which is opened when the message is tapped.,required:false,in:body,ref:,_id:585b96556399952d00e0ac36},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:false,in:body,ref:,_id:585b96556399952d00e0ac35},{name:content.quick_replies,type:object,enumValues:,default:,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,required:false,in:body,ref:,_id:5e427179930618004829a92e},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:amio-chat-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a16a40228bd9b0012b3da22},url:/v1/messages,method:post},isReference:true,order:5,slug:amio-chat-messages-structure-horizontal,type:endpoint,title:Structure - Horizontal Scroll,deprecated:false,icon:,previousSlug:,isBodyEmpty:true,children:},{_id:5e4265735e1c7800199359fa,parentDoc:5c9b6ea5bb4936000e749905,category:5c9b6d0ba42eb00024b4af2c,createdAt:2020-02-11T01:14:51.856Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,examples:{codes:},auth:required,params:,url:,method:get},isReference:true,order:6,slug:amio-chat-messages-quick-replies,type:basic,title:Quick Replies,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9c955da6b59f013bbd7030,createdAt:2019-03-28T09:35:25.990Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b6ea5bb4936000e749905,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:7,slug:amio-chat-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:}},{_id:5c9b7c8d8191a00284a1ce75,createdAt:2019-03-27T13:37:17.160Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:amio-chat-notifications,type:basic,title:Notifications,parentDoc:null,isBodyEmpty:false,children:{_id:5c9b7dd082c4d90039ce67d0,createdAt:2019-03-27T13:42:40.361Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b7c8d8191a00284a1ce75,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331248741\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \type\: \custom\,\n \payload\: {\n \any\: \arbitrary data\\n }\n}}},results:{codes:{status:200,language:json,code:{\n \channel\: {\n \id\: \6456078759331248741\,\n },\n \contact\: {\n \id\: \6456078781510715474\,\n },\n \type\: \custom\,\n \payload\: {\n \any\: \arbitrary data\\n }\n},name:}},settings:,apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{_id:586a5a05e272d81900733a6c,ref:,in:body,required:true,desc:Id of the channel you wish to send the notification to. You can get channel id in administration.,default:,type:string,name:channel.id},{_id:58d271a5eb285919003337c1,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:5a141672e6f0d3001eeceaee,ref:,in:body,required:true,desc:Type specifies the notification to be sent and can have following values:\u003cbr />- `messages_read` - Notifies that all received messages from contact are read.\u003cbr />- `typing_on` - Notifies that the typing indicator should be shown.\u003cbr />- `typing_off` - Notifies that the typing indicator should be hidden.\u003cbr />- `custom` - Any arbitrary notification to be sent. This notification type can contain any arbitrary data sent in `payload`.,default:,type:string,name:type},{_id:5c9b8e448212350186c203ec,ref:,in:body,required:false,desc:Payload is used for `custom` notification type and can contain any arbitrary data.,default:,type:object,name:payload},url:/v1/notifications,method:post},isReference:true,order:0,slug:amio-chat-notifications-send-notification,type:endpoint,title:Send Notification,isBodyEmpty:true,children:}},{_id:5c9b8eae0d3da2001bea412f,createdAt:2019-03-27T14:54:38.225Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:amio-chat-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5c9b8eebbb4936000e749ede,createdAt:2019-03-27T14:55:39.931Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{name:OK,code:\n {\n \id\: \6456078996108099701\,\n \type\: \amio_chat\,\n \name\: \Amio Chat\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n }\n,language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:amio-chat-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9b92776cd20e00141e460c,createdAt:2019-03-27T15:10:47.150Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078996108099701,language:curl}},results:{codes:{name:OK,code:{\n \id\: \6456078996108099701\,\n \type\: \amio_chat\,\n \name\: \Amio Chat\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n},language:json,status:200}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:,url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:amio-chat-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9b93176af65001910a55ad,createdAt:2019-03-27T15:13:28.056Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{name:OK,code:{\n \id\: \6456078996108099701\,\n \type\: \amio_chat\,\n \name\: \Amio Chat\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n }\n},language:json,status:201}},examples:{codes:{code:{\n \type\: \amio_chat\,\n \name\: \Amio Chat\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\ \n }\n},language:json}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `amio_chat`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will generate one.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5c234059e629010a0aa04e},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3bfcad0c8f670012be51ad},url:/v1/channels,method:post},isReference:true,order:2,slug:amio-chat-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9b9a80a0894502f17bd498,createdAt:2019-03-27T15:45:04.413Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n }\n},language:json}},results:{codes:{name:OK,code:{\n \id\: \6456078759331248741\,\n \type\: \amio_chat\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n }\n},language:json,status:200}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d3fd59d3741002afd488d},{name:name,type:string,enumValues:,default:,desc:Name of the channel. Can be an arbitrary name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5c2371cd821a0027d93210},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3bfda6d2a41a004e6f1b79},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:amio-chat-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9b9bcdc05597037ce30784,createdAt:2019-03-27T15:50:37.283Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b8eae0d3da2001bea412f,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331248741,language:curl}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:amio-chat-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5c9b9fa9a78b2f005ddb9652,createdAt:2019-03-27T16:07:05.433Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:amio-chat-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5c9ba08976478e004b9a09d7,createdAt:2019-03-27T16:10:49.241Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b9fa9a78b2f005ddb9652,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510715474\,\n \name\: \6456078781510715474\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331248741/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:amio-chat-contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5c9ba34a87e204000e23bd13,createdAt:2019-03-27T16:22:34.890Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b9fa9a78b2f005ddb9652,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331248741/contacts/6456078781510715474,name:cUrl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510715474\,\n \name\: \6456078781510715474\\n},name:OK}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:amio-chat-contacts-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5c9ba392bb4936000e74a1d4,createdAt:2019-03-27T16:23:46.157Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9b9fa9a78b2f005ddb9652,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331248741/contacts/6456078781510715474,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:amio-chat-contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5c9ba822fcffa30307e45d75,createdAt:2019-03-27T16:43:14.834Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:amio-chat-settings,type:basic,title:Settings,parentDoc:null,isBodyEmpty:false,children:{_id:5c9ba9c28212350186c20852,createdAt:2019-03-27T16:50:10.520Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9ba822fcffa30307e45d75,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331248741/settings,language:curl}},results:{codes:{status:200,language:json,code:{\n \domains_whitelist\: \n \https://app.amio.io\\n \n},name:OK}},apiSetting:5d8abb9de6d3f900f7070305,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:get},isReference:true,order:0,slug:amio-chat-settings-get-settings,type:endpoint,title:Get Settings,isBodyEmpty:false,children:},{_id:5c9baa70f7e4aa005da8c56a,createdAt:2019-03-27T16:53:04.892Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9ba822fcffa30307e45d75,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abb9de6d3f900f7070305,results:{codes:{status:200,language:json,code:{\n \domains_whitelist\: \n \https://app.amio.io\\n \n},name:OK}},examples:{codes:{name:cUrl,code:{\n \domains_whitelist\: \n \https://app.amio.io\\n \n},language:json}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:patch},isReference:true,order:1,slug:amio-chat-settings-update-settings,type:endpoint,title:Update Settings,isBodyEmpty:false,children:},{_id:5c9ba96d6ef40a003fc0c4a1,createdAt:2019-03-27T16:48:45.267Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9ba822fcffa30307e45d75,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:amio-chat-settings-domains-whitelist,type:basic,title:Domains Whitelist,isBodyEmpty:false,children:}},{_id:5c9baeb7bb4936000e74a2fa,createdAt:2019-03-27T17:11:19.613Z,category:5c9b6d0ba42eb00024b4af2c,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,auth:required,params:,url:,method:get},isReference:true,order:6,slug:amio-chat-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5c9baf916cd20e00141e4988,createdAt:2019-03-27T17:14:57.812Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:amio-chat-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5c9c91c85a6dd1000e881783,createdAt:2019-03-28T09:20:08.852Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:amio-chat-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5c9c9292e7592c005d96492d,createdAt:2019-03-28T09:23:30.825Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:2,slug:amio-chat-webhooks-messages-read,type:basic,title:Messages Read,previousSlug:messages-read,isBodyEmpty:false,children:},{_id:5c9c9489e041200062a3495d,createdAt:2019-03-28T09:31:53.880Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:amio-chat-webhooks-message-echo,type:basic,title:Message Echo,isBodyEmpty:false,children:},{_id:5c9cc01e3dac6900502ccd40,createdAt:2019-03-28T12:37:50.239Z,category:5c9b6d0ba42eb00024b4af2c,parentDoc:5c9baeb7bb4936000e74a2fa,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:amio-chat-webhooks-notification-received,type:basic,title:Notification Received,isBodyEmpty:false,children:},{_id:60cc68cf87ccfc0359aa4b7f,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Postback Received,type:basic,slug:amio-chat-webhooks-postback-received,order:5,isReference:true,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:postback-received,createdAt:2021-06-18T09:35:11.294Z,parentDoc:5c9baeb7bb4936000e74a2fa,category:5c9b6d0ba42eb00024b4af2c,isBodyEmpty:false,children:}}},{_id:5dc53a440d5f2d004363aee2,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:true,reference:true,createdAt:2019-11-08T09:49:56.308Z,order:4,slug:email,title:Email - Daktela,__v:0,pages:{_id:5dc53a440d5f2d004363aee3,createdAt:2019-11-08T09:49:56.344Z,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{auth:required,params:,url:,method:get,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}}},isReference:true,order:0,slug:api-email-daktela,type:basic,title:Email - Daktela,parentDoc:null,deprecated:false,icon:,previousSlug:api-email,isBodyEmpty:false,children:},{_id:5dc53b8d1f8feb007286fdb6,createdAt:2019-11-08T09:55:25.060Z,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:email-daktela-messages,type:basic,title:Messages,parentDoc:null,deprecated:false,icon:,previousSlug:email-messages,isBodyEmpty:false,children:{_id:5ddb992c91b2510044df0714,createdAt:2019-11-25T09:04:44.442Z,parentDoc:5dc53b8d1f8feb007286fdb6,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6646948773235533878\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello.\\n }\n}\n,name:JSON}},results:{codes:{name:null,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \email_daktela\\n },\n \contact\: {\n \id\: \6646948773235533878\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello.\\n }\n},language:json,status:201}},settings:,apiSetting:5dc53a440d5f2d004363aee0,auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:,_id:586d2081a63f5d2500c86b83},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `text`.,required:true,in:body,ref:,_id:586d20b39a854123001acd78},{name:content.payload,type:string,enumValues:,default:,desc:Text to be sent. Maximum size is 4096 characters.,required:true,in:body,ref:,_id:586d20b39a854123001acd77},{name:metadata,type:object,enumValues:,default:,desc:,required:false,in:body,ref:,_id:5a16a39a38e7e000128181a6},url:/v1/messages,method:post},isReference:true,order:0,slug:email-daktela-messages-text,type:endpoint,title:Text,deprecated:false,icon:,previousSlug:email-messages-text,isBodyEmpty:false,children:}},{_id:5dd25563231a61005516730f,createdAt:2019-11-18T08:25:07.887Z,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:email-daktela-channels,type:basic,title:Channels,parentDoc:null,deprecated:false,icon:,previousSlug:email-channels,isBodyEmpty:false,children:{_id:5e13466d020bd3004f3c7108,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T05:28:31.770Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078759331238786\,\n \type\: \email_daktela\,\n \name\: \Support Email\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://your-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\,\n \daktela_processed_category\: null\n }\n }\n,name:}},auth:required,params:{name:max,type:int,enumValues:,default:,desc:Maximum number of channels in the response.,required:false,in:query,ref:,_id:642abcf60fca1c024dbb6760},{name:offset,type:int,enumValues:,default:,desc:Offset of the channel list in the response.,required:false,in:query,ref:,_id:642abcf60fca1c024dbb675f},url:/v1/channels,method:get,apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels}}},isReference:true,order:0,slug:email-daktela-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,previousSlug:email-channels-list-channels,mdx:{},isBodyEmpty:false,children:},{_id:5e134839b1196a02ef0edc04,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T13:23:57.656Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786}},apiSetting:5dc53a440d5f2d004363aee0,results:{codes:{status:200,language:json,code: {\n \id\: \6456078759331238786\,\n \type\: \email\,\n \name\: \Support Email\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://your-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\,\n \daktela_processed_category\: null\n }\n}\n,name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e135623f56e02005fcbb1ac},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:email-daktela-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,previousSlug:email-channels-get-channel,mdx:{},isBodyEmpty:false,children:},{_id:5ddbb2311e4e2f00208366cf,createdAt:2019-11-25T10:51:29.847Z,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \type\: \email\,\n \name\: \Support Email\,\n \webhook\: {\n \url\: \https://your-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\\n }\n}\n}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \email\,\n \name\: \Support Email\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://your-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\,\n \daktela_processed_category\: null\n }\n},language:json,status:201}},apiSetting:5dc53a440d5f2d004363aee0,auth:required,params:{name:type,type:string,enumValues:,default:email_daktela,desc:Channel type, `email_daktela`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:Email Daktela,desc:Name of the channel. If not set, it will be `Email Daktela`.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d05bdd4f531001fbc67d1},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c01c1a96b58003961c233},{name:daktela,type:object,enumValues:,default:,desc:Contains Daktela-related configuration.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b7},{name:daktela.access_token,type:string,enumValues:,default:123456789abcdef,desc:Access token of a Daktela user on whose behalf the actions are made.,required:true,in:body,ref:,_id:5dd2605e45075e0065e94919},{name:daktela.daktela_url,type:string,enumValues:,default:https://your-company.daktela.com,desc:URL of Daktela instance.,required:true,in:body,ref:,_id:5dd2605e45075e0065e94918},{name:daktela.daktela_ticket_category,type:string,enumValues:,default:Support,desc:Used during handover to operator - the tickets category will be changed to this value.,required:true,in:body,ref:,_id:5e133e9e05d1a8019c3e60a0},{name:daktela.daktela_user_name,type:string,enumValues:,default:user_name,desc:Optional. Used during handover to operator - the ticket will be assigned to this user.,required:false,in:body,ref:,_id:5e133e9e05d1a8019c3e609f},{name:daktela.daktela_queue,type:string,enumValues:,default:1001,desc:Name of queue in Daktela which this channel is connected to.,required:false,in:body,ref:,_id:646cb8dcec9e7e0dcb317425},{name:daktela.daktela_processed_category,type:string,enumValues:,default:category_12345,desc:Optional. Only process email tickets that have this category set. If `daktela_processed_category`is null, process all emails. If `daktela_processed_category` is \NO_CATEGORY\, process only email tickets without a category.,required:false,in:body,ref:,_id:65e9e2228a8f43003633f283},url:/v1/channels,method:post},isReference:true,order:2,slug:email-daktela-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,previousSlug:email-channels-create-channel,mdx:{},isBodyEmpty:false,children:},{_id:5e13493eb89973001ee3876b,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T04:53:29.257Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \email\,\n \name\: \New Support Email\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://new-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_queue\: \1001\,\n \daktela_processed_category\: \category_12345\\n }\n},language:json,status:201}},examples:{codes:{language:json,code:{\n \name\: \New Support Email\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://new-company.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\\n },\n \daktela\: {\n \access_token\: \123456789abcdef\,\n \daktela_url\: \https://your-company.daktela.com\,\n \daktela_ticket_category\: \Support\,\n \daktela_user_name\: \user_name\,\n \daktela_processed_category\: \category_12345\\n }\n}\n}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e135632f56e02005fcbb1b2},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be `Email`.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d05bdd4f531001fbc67d1},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c0221ecfa670041e55c0d},{name:daktela,type:object,enumValues:,default:,desc:Contains Daktela-related configuration.,required:false,in:body,ref:,_id:5a1d322f61bdc2003611d6b7},{name:daktela.access_token,type:string,enumValues:,default:,desc:Access token of a Daktela user on whose behalf the actions are made.,required:false,in:body,ref:,_id:5dd2605e45075e0065e94919},{name:daktela.daktela_url,type:string,enumValues:,default:,desc:URL of Daktela instance.,required:false,in:body,ref:,_id:5dd2605e45075e0065e94918},{name:daktela.daktela_ticket_category,type:string,enumValues:,default:,desc:Used during handover to operator - the tickets category will be changed to this value.,required:false,in:body,ref:,_id:5e133e9e05d1a8019c3e60a0},{name:daktela.daktela_user_name,type:string,enumValues:,default:,desc:Optional. Used during handover to operator - the ticket will be assigned to this user.,required:false,in:body,ref:,_id:5e133e9e05d1a8019c3e609f},{name:daktela.daktela_queue,type:string,enumValues:,default:,desc:Name of queue in Daktela which this channel is connected to.,required:false,in:body,ref:,_id:646cb9c0e65360005e93218e},{name:daktela.daktela_processed_category,type:string,enumValues:,default:category_12345,desc:Optional. Only process email tickets that have this category set. If `daktela_processed_category`is null, process all emails. If `daktela_processed_category` is \NO_CATEGORY\, process only email tickets without a category.,required:false,in:body,ref:,_id:65e9e282d943820011db8e6a},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:email-daktela-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,previousSlug:email-channels-update-channel,mdx:{},isBodyEmpty:false,children:},{_id:5e1349c605d1a8019c3e61bd,parentDoc:5dd25563231a61005516730f,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T07:07:30.441Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786}},results:{codes:{name:,code: ,language:json,status:204}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e1356432ba7c4001123eeb3},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:email-daktela-channels-delete-channel,type:endpoint,title:Delete Channel,deprecated:false,icon:,previousSlug:email-channels-delete-channel,isBodyEmpty:true,children:}},{_id:5e1353b438b739005680ebca,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T04:53:29.579Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:email-daktela-contacts,type:basic,title:Contacts,parentDoc:null,deprecated:false,icon:,previousSlug:email-contacts,isBodyEmpty:false,children:{_id:5e13551f020bd3004f3c726c,parentDoc:5e1353b438b739005680ebca,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T05:28:31.770Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{name:null,language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6619965168536114630\,\n \name\: \john@customer.com\\n }\n,name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e13551f020bd3004f3c726d},{name:max,type:int,enumValues:,default:,desc:Maximum number of contacts to retrieve.,required:false,in:query,ref:,_id:642bf47ae7b7f4004adc1e04},{name:offset,type:int,enumValues:,default:,desc:Offset of the retrieved contact list.,required:false,in:query,ref:,_id:642bf47ae7b7f4004adc1e03},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:email-daktela-contacts-list-contacts,type:endpoint,title:List Contacts,deprecated:false,icon:,previousSlug:email-contacts-list-contacts,isBodyEmpty:false,children:},{_id:5e1356b336a65202d530a001,parentDoc:5e1353b438b739005680ebca,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T13:10:50.375Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6619965168536114630}},results:{codes:{status:200,language:json,code:{\n \id\: \6619965168536114630\,\n \name\: \john@customer.com\\n},name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e1356b336a65202d530a003},{name:contact_id,type:string,enumValues:,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5e1356b336a65202d530a002},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:email-daktela-contacts-get-contact,type:endpoint,title:Get Contact,deprecated:false,icon:,previousSlug:email-contacts-get-contact,isBodyEmpty:false,children:},{_id:5e135784b1196a02ef0edd42,parentDoc:5e1353b438b739005680ebca,category:5dc53a440d5f2d004363aee2,createdAt:2020-01-06T13:23:57.656Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dc53a440d5f2d004363aee0,examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339}},results:{codes:{status:204,language:json,code: ,name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5e135784b1196a02ef0edd44},{name:contact_id,type:string,enumValues:,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5e135784b1196a02ef0edd43},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:email-daktela-contact-delete-contact,type:endpoint,title:Delete Contact,deprecated:false,icon:,previousSlug:email-contact-delete-contact,isBodyEmpty:true,children:}},{_id:5dc53e58d2bd610421b37ddc,createdAt:2019-11-08T10:07:20.508Z,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:email-daktela-webhooks,type:basic,title:Webhooks,parentDoc:null,deprecated:false,icon:,previousSlug:email-webhooks,isBodyEmpty:false,children:{_id:5dc53f2c7f77f00026cd18fb,createdAt:2019-11-08T10:10:52.968Z,parentDoc:5dc53e58d2bd610421b37ddc,category:5dc53a440d5f2d004363aee2,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:email-daktela-message-received,type:basic,title:Message Received,deprecated:false,icon:,previousSlug:email-message-received,mdx:{},isBodyEmpty:false,children:}}},{_id:59fc42803cf718001069b926,from_sync:false,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,sync:{isSync:false,url:},slug:facebook-messenger-1,title:Facebook Messenger,__v:0,reference:true,createdAt:2016-12-10T11:25:06.059Z,order:5,pages:{_id:59fc42803cf718001069b939,hidden:false,link_url:,api:{auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{name:,status:400,language:json,code:{}}},settings:,url:},category:59fc42803cf718001069b926,createdAt:2016-12-19T10:10:54.551Z,title:Facebook Messenger,sync_unique:,type:basic,isReference:true,link_external:false,order:0,parentDoc:null,slug:api-facebook-messenger,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b936,hidden:false,parentDoc:null,createdAt:2016-12-10T11:26:50.710Z,link_url:,order:1,slug:facebook-messenger-messages,type:basic,api:{examples:{codes:{language:text,code:{\n \platform\: \facebook_messenger\,\n \recipient\: {\n \id\: \USER_ID\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hellow world!\\n },\n \Headers\: \\\n}}},method:get,params:,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},settings:,url:,auth:required},category:59fc42803cf718001069b926,title:Messages,isReference:true,link_external:false,sync_unique:,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:{_id:5a70712ac3cfa000542fbd50,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2018-01-30T13:20:42.788Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,examples:{codes:{code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages,language:curl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078996108088196\, \n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,name:}},auth:required,params:{_id:5a7071e1b3c9580024d1a2f5,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a7071e1b3c9580024d1a2f4,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:facebook-messenger-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b937,slug:facebook-messenger-messages-text,isReference:true,link_url:,hidden:false,category:59fc42803cf718001069b926,order:1,sync_unique:,type:endpoint,api:{examples:{codes:{name:JSON,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 640 characters.,default:,type:string,name:content.payload},{_id:598749c6720847000fea20e3,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a39a38e7e000128181a6,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:null,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},language:json,status:201}},settings:,url:/v1/messages,auth:required,apiSetting:5d8e9953589ec60039e75d81},link_external:false,parentDoc:59fc42803cf718001069b936,title:Text,createdAt:2016-12-10T11:27:03.188Z,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b943,type:endpoint,order:2,category:59fc42803cf718001069b926,createdAt:2016-12-21T12:15:48.727Z,isReference:true,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-image,sync_unique:,link_url:,title:Image,api:{auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:content.payload.url},{_id:59874a1e084150000f5194a5,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json,status:201}},settings:,url:/v1/messages,apiSetting:5d8e99f1ebdd2c006b877e28},hidden:false,link_external:false,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b947,link_url:,type:endpoint,sync_unique:,api:{url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \audio\,\n \payload\: {\n \url\: \http://dubioza.org/site/wp-content/uploads/2016/02/1.-All-Equal-feat-BEE2.mp3\\n }\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `audio`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the audio to be sent. Max size is 25 MB.,default:,type:string,name:content.payload.url},{_id:59874a4b743049000f350017,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3cd28bd9b0012b3da21,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \audio\,\n \payload\: {\n \url\: \http://dubioza.org/site/wp-content/uploads/2016/02/1.-All-Equal-feat-BEE2.mp3\\n }\n }\n},language:json,status:201}},settings:,apiSetting:5d8e9a98c4c04c00696b57ca},isReference:true,link_external:false,slug:facebook-messenger-messages-audio,title:Audio,category:59fc42803cf718001069b926,createdAt:2016-12-22T08:38:04.366Z,hidden:false,order:3,parentDoc:59fc42803cf718001069b936,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b948,api:{method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `video`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the video to be sent. Max size is 25 MB.,default:,type:string,name:content.payload.url},{_id:59874a6ac66549000f043b40,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3d6f7b5a0001e036bf6,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},name:}},settings:,url:/v1/messages,auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},language:json}},apiSetting:5d8e9b7719f4740011d43b89},hidden:false,parentDoc:59fc42803cf718001069b936,sync_unique:,type:endpoint,category:59fc42803cf718001069b926,link_external:false,createdAt:2016-12-22T08:42:42.861Z,isReference:true,link_url:,order:4,slug:facebook-messenger-messages-video,title:Video,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b949,sync_unique:,type:endpoint,category:59fc42803cf718001069b926,link_url:,link_external:false,order:5,createdAt:2016-12-22T08:43:08.506Z,isReference:true,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-file,title:File,api:{method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `file`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the file to be sent. Max size is 25 MB.,default:,type:string,name:content.payload.url},{_id:59874a8c564140000f53e5a5,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3e0f7b5a0001e036bf8,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \http://example.com/pdf.pdf\\n }\n }\n},language:json,status:201}},settings:,url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \http://example.com/pdf.pdf\\n }\n }\n}}},apiSetting:5d8e9bc3f4e44300312dd1b7},hidden:false,isBodyEmpty:false,children:},{_id:5a33d15e7698a1001ca9855e,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2017-12-15T13:42:54.514Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:6,slug:facebook-messenger-messages-location,type:basic,title:Location,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b94e,link_url:,order:7,sync_unique:,createdAt:2017-01-02T15:22:11.178Z,hidden:false,link_external:false,api:{settings:,url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \receipt\,\n \payload\: {\n \order_id\: \id546584\, \n \timestamp\: \2016-10-06T13:42:48Z\,\n \currency\: \USD\,\n \payment_method\: \Visa ***8138.\,\n \url_order\: \http://petersapparel.parseapp.com/order?order_idid546584\,\n \shipping_address\: {\n \name\: \Tomáš Baťa\,\n \address_line_1\: \tř. Tomáše Bati 46\,\n \address_line_2\: \company Bata a.s.\,\n \city\: \Otrokovice\,\n \postal_code\: \765 02\,\n \state\: \Zlín Region\,\n \country_code\: \CZ\\n },\n \items\: \n {\n \title\:\Winter Mens Footware\,\n \text\:\100% Leather\,\n \quantity\:1,\n \price\:67.5,\n \image_url\:\http://3-cz-cdn.bata.eu/gallery/1/6/4/5/7/c.jpg\\n }\n ,\n \summary\: {\n \shipping\: 4.95,\n \tax\: 6.19,\n \total\: 78.64\n }\n }\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `receipt`.,default:,type:string,name:content.type},{_id:586c01f75acc511b00c38681,ref:,in:body,required:true,desc:Order id. Has to be unique for each recepient.,default:,type:string,name:payload.order_id},{_id:586bff410abf1d0f000d04d2,ref:,in:body,required:false,desc:Timestamp of the order. Must be in ISO 8601(https://en.wikipedia.org/wiki/ISO_8601) timestamp form, e.g. *2016-10-06T13:42:48Z*. This timestamp is zone agnostic it means that if you use zone in your format, the time will be shifted to UTC.,default:,type:datetime,name:payload.timestamp},{_id:586c009c50fe5a0f004ab7b0,ref:,in:body,required:true,desc:Currency in the form of ISO 4217(https://en.wikipedia.org/wiki/ISO_4217), e.g. *USD* or *CZK*.,default:,type:string,name:payload.currency},{_id:586c01f75acc511b00c38682,ref:,in:body,required:false,desc:URL with order details.,default:,type:string,name:payload.url_order},{_id:586c04e550fe5a0f004ab7b8,ref:,in:body,required:true,desc:Payment method. This can be a custom string, e.g. *Visa 1234*.,default:,type:string,name:payload.payment_method},{_id:586c04e550fe5a0f004ab7b7,ref:,in:body,required:true,desc:Recipients full name. Required if address is set.,default:,type:string,name:shipping_address.name},{_id:586ab7389698b91900f84938,ref:,in:body,required:false,desc:Address line 1, P.O. box, company name, c/o. Required if city is set.,default:,type:string,name:shipping_address.address_line_1},{_id:586ab7a57f27f439005b5760,ref:,in:body,required:false,desc:Apartment, suite, unit, building, floor, etc.,default:,type:string,name:shipping_address.address_line_2},{_id:587362ae1ddb870f008bad48,ref:,in:body,required:false,desc:City. Required if address is set. Required if address_line_1is set.,default:,type:string,name:shipping_address.city},{_id:586ab7a57f27f439005b575f,ref:,in:body,required:false,desc:Postal Code. Required if address is set. Required if address_line_1is set.,default:,type:string,name:shipping_address.postal_code},{_id:586c05d5cb4ea827001fd11f,ref:,in:body,required:false,desc:State abbreviation or Region/Province (international). Required if address_line_1is set.,default:,type:string,name:shipping_address.state},{_id:586c05d5cb4ea827001fd11e,ref:,in:body,required:false,desc:Country code according to ISO 3166 - alpha2(https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Required if address_line_1is set.,default:,type:string,name:shipping_address.country_code},{_id:586e6951e894522f003aea44,ref:,in:body,required:false,desc:Item title. Required if item is set.,default:,type:string,name:items.title},{_id:586e6951e894522f003aea43,ref:,in:body,required:false,desc:Item subtitle.,default:,type:string,name:items.text},{_id:586e6951e894522f003aea42,ref:,in:body,required:false,desc:Quantity of items.,default:,type:int,name:items.quantity},{_id:586e6951e894522f003aea41,ref:,in:body,required:false,desc:Price of the item. 0 is allowed. Required if item is set.,default:,type:double,name:items.price},{_id:586e6951e894522f003aea40,ref:,in:body,required:false,desc:Url of the item image.,default:,type:string,name:items.image_url},{_id:586e6951e894522f003aea3f,ref:,in:body,required:false,desc:Cost of shipping.,default:,type:double,name:summary.shipping},{_id:586e6951e894522f003aea3e,ref:,in:body,required:false,desc:Total tax.,default:,type:double,name:summary.tax},{_id:586e6951e894522f003aea3d,ref:,in:body,required:true,desc:Total cost.,default:,type:double,name:summary.total},{_id:59874adc084150000f5194a6,ref:,in:body,required:false,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,default:,type:array_object,name:content.quick_replies},{_id:5a16a3ec9610050012c4a2d6,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \receipt\,\n \payload\: {\n \order_id\: \id546584\, \n \timestamp\: \2016-10-06T13:42:48Z\,\n \currency\: \USD\,\n \payment_method\: \Visa ***8138.\,\n \url_order\: \http://petersapparel.parseapp.com/order?order_idid546584\,\n \shipping_address\: {\n \name\: \Tomáš Baťa\,\n \address_line_1\: \tř. Tomáče Bati 46\,\n \address_line_2\: \company Bata a.s.\,\n \city\: \Otrokovice\,\n \postal_code\: \765 02\,\n \country_code\: \CZ\\n },\n \items\: \n {\n \title\:\Winter Mens Footware\,\n \text\:\100% Leather\,\n \quantity\:1,\n \price\:67.5,\n \image_url\:\http://3-cz-cdn.bata.eu/gallery/1/6/4/5/7/c.jpg\\n }\n ,\n \summary\: {\n \shipping\: 4.95,\n \tax\: 6.19,\n \total\: 78.64\n }\n }\n }\n},language:json,status:201}},apiSetting:5d8e9c39f4e44300312dd1c7},category:59fc42803cf718001069b926,title:Receipt,type:endpoint,isReference:true,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-receipt,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b94a,api:{results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},settings:,url:/v1/messages,auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},method:post,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:payload.title,type:string,enumValues:,default:,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`. You can also omit the title attribute and use only `text` and `buttons` attributes.,required:false,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:payload.text,type:string,enumValues:,default:,desc:Message text. **Max size** 80 characters. However, you can use **up to 640 characters** if you use` text` with `buttons` only.,required:false,in:body,ref:,_id:585b96556399952d00e0ac38},{name:payload.image_url,type:string,enumValues:,default:,desc:Url of an image to be displayed. Image ratio is 1.91:1.,required:false,in:body,ref:,_id:585b96556399952d00e0ac37},{name:payload.item_url,type:string,enumValues:,default:,desc:Url which is opened when the message is tapped.,required:false,in:body,ref:,_id:585b96556399952d00e0ac36},{name:payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:false,in:body,ref:,_id:585b96556399952d00e0ac35},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a58e527791cac001c857652},apiSetting:5d8e9cdeebdd2c006b877e50},category:59fc42803cf718001069b926,link_external:false,title:Structure,link_url:,sync_unique:,type:endpoint,createdAt:2016-12-22T08:44:33.901Z,isReference:true,order:8,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-structure,hidden:false,previousSlug:,deprecated:false,icon:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b94b,hidden:false,isReference:true,link_url:,type:endpoint,link_external:false,parentDoc:59fc42803cf718001069b936,slug:facebook-messenger-messages-structure-horizontal-scroll,api:{auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger with Coleslaw salad\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `structure`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`.,default:,type:string,name:payload.title},{_id:585b96556399952d00e0ac38,ref:,in:body,required:false,desc:Message text. **Max size** 80 characters.,default:,type:string,name:payload.text},{_id:585b96556399952d00e0ac37,ref:,in:body,required:false,desc:Url of an image to be displayed. Image ratio is 1.91:1.,default:,type:string,name:payload.image_url},{_id:585b96556399952d00e0ac36,ref:,in:body,required:false,desc:Url which is opened when the message is tapped.,default:,type:string,name:payload.item_url},{_id:585b96556399952d00e0ac35,ref:,in:body,required:false,desc:Buttons to be shown below the message. Limetted to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,default:,type:array_object,name:payload.buttons},{_id:5a16a40228bd9b0012b3da22,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},results:{codes:{name:,status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger with Coleslaw salad\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n}}},settings:,url:/v1/messages,apiSetting:5d8e9ea50f3b8a002575a34b},category:59fc42803cf718001069b926,createdAt:2016-12-22T10:31:14.466Z,order:9,sync_unique:,title:Structure - Horizontal Scroll,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b950,link_url:,createdAt:2017-01-06T13:31:36.252Z,isReference:true,slug:facebook-messenger-messages-buttons,category:59fc42803cf718001069b926,title:Buttons,type:basic,link_external:false,order:10,hidden:false,parentDoc:59fc42803cf718001069b936,sync_unique:,api:{results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,examples:{codes:},method:get,params:},deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b9a2,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2017-08-06T10:23:42.785Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:},settings:,results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:11,slug:facebook-messenger-messages-quick-replies,type:basic,title:Quick Replies,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a16a20928bd9b0012b3d9b4,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2017-11-23T10:25:13.563Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:12,slug:facebook-messenger-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:},{_id:5ae725e3ea73080003370581,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2018-04-30T14:19:15.475Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:13,slug:facebook-messenger-messages-types,type:basic,title:Types,isBodyEmpty:false,children:},{_id:5a27c3abffe263002650fec7,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b936,createdAt:2017-12-06T10:17:15.060Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:14,slug:facebook-messenger-messages-tags,type:basic,title:Tags,isBodyEmpty:false,children:}},{_id:5a14130a05c0b0001e507e06,category:59fc42803cf718001069b926,createdAt:2017-11-21T11:50:34.165Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:facebook-messenger-notifications,type:basic,title:Notifications,parentDoc:null,isBodyEmpty:false,children:{_id:5a141584f96ca1003caf7f80,category:59fc42803cf718001069b926,parentDoc:5a14130a05c0b0001e507e06,createdAt:2017-11-21T12:01:08.455Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,settings:,results:{codes:{name:,code:{\n \channel\: {\n \id\: \6456078759331238786\,\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \type\: \typing_on\\n},language:json,status:200}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \type\: \typing_on\\n},language:json}},auth:required,params:{_id:586a5a05e272d81900733a6c,ref:,in:body,required:true,desc:Id of the channel you wish to send the notification to. You can get channel id in administration.,default:,type:string,name:channel.id},{_id:58d271a5eb285919003337c1,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:5a141672e6f0d3001eeceaee,ref:,in:body,required:true,desc:Type specifies the notification to be sent and can have following values: \u003cbr />- `messages_read` - shows that all received messages from contact are read \u003cbr />- `typing_on` - shows the typing indicator \u003cbr />- `typing_off` - hides the typing indicator - if you dont switch off the typing indicator, it is switched off automatically (typically in 20 seconds).,default:,type:string,name:type},url:/v1/notifications,method:post},isReference:true,order:0,slug:facebook-messenger-notifications-send-notification,type:endpoint,title:Send Notification,isBodyEmpty:false,children:}},{_id:5a1d20a4370eeb002af86fb0,category:59fc42803cf718001069b926,createdAt:2017-11-28T08:39:00.180Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:facebook-messenger-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5a1d213b67d310001245bd1c,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T08:41:31.323Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},results:{codes:{name:OK,code:\n {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \name\: \Amio\,\n \category\: \Internet Company\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n }\n,language:json,status:200}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:facebook-messenger-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d279867d310001245bdd0,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T09:08:40.005Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \name\: \Amio\,\n \category\: \Internet Company\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n},language:json,status:200}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},auth:required,params:,url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:facebook-messenger-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d284a9d3741002afd4524,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T09:11:38.412Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \type\: \facebook_messenger\,\n \name\: \Amio Channel\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n},language:json}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\,\n \name\: \Amio Channel\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \TsEW3ZmFKmpe2WltNfVmqtQie24\,\n \ssl_verification\: true\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \name\: \Amio\,\n \category\: \Internet Company\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n},language:json,status:201}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `facebook_messenger`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be filled with connected Facebook Page name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d05bdd4f531001fbc67d1},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c025c68b40d005007381a},{name:facebook_page.id,type:string,enumValues:,default:,desc:Id of the facebook page to be connected.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b7},{name:facebook_page.access_token,type:string,enumValues:,default:,desc:Access token to be used for Facebook API calls. This can be any type of access token with required permission. Typically, you will send User Access Token obtained after successful Facebook OAuth login procedure. When you create a channel, we request for long lived Page Access Token what ensures that the access token wont expire. See Facebook documentation(https://developers.facebook.com/docs/facebook-login/access-tokens) for more details.\u003cbr />\u003cbr />You can only use access tokens that were generated for a certain Facebook App. If you want to use your own Facebook App, let us know at support@amio.io(mailto:support@amio.io). This SO(https://stackoverflow.com/questions/52053140/cannot-create-a-channel-via-api-in-amio-io/52071941#52071941) answer explains how to generate `access_token` for a given Facebook Application.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b4},url:/v1/channels,method:post},isReference:true,order:2,slug:facebook-messenger-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d3f7267d310001245bffb,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T10:50:26.065Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \facebook_page\: {\n \id\: \747722755375845\,\n \name\: \Amio\,\n \category\: \Internet Company\,\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n},language:json,status:200}},examples:{codes:{language:json,code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \facebook_page\: {\n \access_token\: \9mqyDMPBtgRG3{nWLYYh\\n }\n}}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d3fd59d3741002afd488d},{name:name,type:string,enumValues:,default:,desc:Name of the channel. Might be an arbitrary name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d05ff173c120053dc6657},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:facebook_page.access_token,type:string,enumValues:,default:,desc:Access token to be used for Facebook API calls. This can be any type of access token with required permission. Typically, you will send User Access Token obtained after successful Facebook OAuth login procedure. When you create a channel, we request for long lived Page Access Token what ensures that the access token wont expire. See Facebook documentation(https://developers.facebook.com/docs/facebook-login/access-tokens) for more details.\u003cbr />\u003cbr />You can only use access tokens that were generated for a certain Facebook App. If you want to use your own Facebook App, let us know at support@amio.io(mailto:support@amio.io). This SO(https://stackoverflow.com/questions/52053140/cannot-create-a-channel-via-api-in-amio-io/52071941#52071941) answer explains how to generate `access_token` for a given Facebook Application.,required:false,in:body,ref:,_id:5cdbf59ce607e5000ebde527},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c028a6b04ee0270f29a7f},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:facebook-messenger-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d409fd31946001cc1309c,category:59fc42803cf718001069b926,parentDoc:5a1d20a4370eeb002af86fb0,createdAt:2017-11-28T10:55:27.047Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:facebook-messenger-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5a131534b57953001cece0e4,category:59fc42803cf718001069b926,createdAt:2017-11-20T17:47:32.693Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:facebook-messenger-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5a13159845769d002674f1ca,category:59fc42803cf718001069b926,parentDoc:5a131534b57953001cece0e4,createdAt:2017-11-20T17:49:12.929Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\,\n \gender\: \male\,\n \locale\: \de_DE\,\n \time_zone\: \+02:00\,\n \photo_url\: \https://storage.amio.io/profile/6456078781510718339/avatar\\n }\n,name:OK}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:facebook-messenger-contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5a1315c2b57953001cece0e8,category:59fc42803cf718001069b926,parentDoc:5a131534b57953001cece0e4,createdAt:2017-11-20T17:49:54.645Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,results:{codes:{name:OK,code:{\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \user_ref\: \123456789\,\n \name\: \Dietrich Bonhoeffer\,\n \gender\: \male\,\n \locale\: \de_DE\,\n \time_zone\: \+02:00\,\n \photo_url\: \https://storage.amio.io/profile/6456078781510718339/avatar\\n },language:json,status:200}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:facebook-messenger-contacts-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5a1315ccddc95100120c4a0b,category:59fc42803cf718001069b926,parentDoc:5a131534b57953001cece0e4,createdAt:2017-11-20T17:50:04.060Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:facebook-messenger-contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:59fc42803cf718001069b97b,api:{results:{codes:{status:200,language:json,code:{},name:},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},slug:facebook-messenger-settings,category:59fc42803cf718001069b926,hidden:false,link_url:,parentDoc:null,title:Settings,type:basic,link_external:false,createdAt:2017-05-01T08:48:58.812Z,isReference:true,order:5,sync_unique:,isBodyEmpty:false,children:{_id:5a142be1d93a490028dc7c7d,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b97b,createdAt:2017-11-21T13:36:33.034Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abbeb669e910036e59635,results:{codes:{status:200,language:json,code:{\n \get_started_button\: {\n \payload\: \{{GET_STARTED_PAYLOAD}}\\n },\n \menu\: \n {\n \locale\: \default\,\n \items\: \n {\n \type\: \url\,\n \title\: \URL Item\,\n \payload\: \http://www.google.com\\n }\n \n }\n ,\n \user_inputs\: \n {\n \locale\: \default\,\n \enabled\: true\n }\n ,\n \domains_whitelist\: \n \https://app.amio.io\\n \n},name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/settings,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:get},isReference:true,order:0,slug:facebook-messenger-settings-get-settings,type:endpoint,title:Get Settings,isBodyEmpty:false,children:},{_id:5c63e6ce72efad0126555b1f,createdAt:2019-02-13T09:43:42.958Z,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b97b,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:{\n \get_started_button\: {\n \payload\: \{{GET_STARTED_PAYLOAD}}\\n },\n \menu\: \n {\n \locale\: \default\,\n \items\: \n {\n \type\: \url\,\n \title\: \URL Item\,\n \payload\: \http://www.google.com\\n }\n \n }\n ,\n \user_inputs\: \n {\n \locale\: \default\,\n \enabled\: true\n }\n ,\n \domains_whitelist\: \n \https://app.amio.io\\n \n},language:json}},results:{codes:{status:200,language:json,code:{\n \get_started_button\: {\n \payload\: \{{GET_STARTED_PAYLOAD}}\\n },\n \menu\: \n {\n \locale\: \default\,\n \items\: \n {\n \type\: \url\,\n \title\: \URL Item\,\n \payload\: \http://www.google.com\\n }\n \n }\n ,\n \user_inputs\: \n {\n \locale\: \default\,\n \enabled\: true\n }\n ,\n \domains_whitelist\: \n \https://app.amio.io\\n \n},name:OK}},apiSetting:5d8abbeb669e910036e59635,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/settings,method:patch},isReference:true,order:1,slug:facebook-messenger-settings-update-settings,type:endpoint,title:Update Settings,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b98b,slug:facebook-messeger-settings-get-started-button,title:Get Started Button,hidden:false,isReference:true,link_url:,type:basic,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},order:2,parentDoc:59fc42803cf718001069b97b,sync_unique:,createdAt:2017-05-19T12:14:37.657Z,link_external:false,category:59fc42803cf718001069b926,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b97c,api:{method:post,params:,results:{codes:{status:201,language:json,code:{}\t,name:}},url:/v1/channels/{channel_id}/menus,auth:required,examples:{codes:{code:{\n \payload\: {\n \menu_items\: \n {\n \type\: \url\,\n \title\: \URL Menu\,\n \payload\: \http://www.google.com\\n },\n {\n \type\: \postback\,\n \title\: \POSTBACK Menu\,\n \payload\: \POSTBACK DATA\\n },\n {\n \type\: \menu\,\n \title\: \NESTED Menu\,\n \payload\: {\n \menu_items\: \n {\n \type\: \url\,\n \title\: \NESTED URL Menu\,\n \payload\: \http://www.google.com\\n },\n {\n \type\: \postback\,\n \title\: \NESTED POSTBACK Menu\,\n \payload\: \POSTBACK DATA\\n }\n \n }\n }\n \n }\n}\t,language:json}}},isReference:true,parentDoc:59fc42803cf718001069b97b,slug:facebook-messeger-settings-menu,title:Menu,category:59fc42803cf718001069b926,createdAt:2017-05-01T08:49:25.359Z,hidden:false,link_url:,order:3,sync_unique:,link_external:false,type:basic,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b98e,category:59fc42803cf718001069b926,order:4,parentDoc:59fc42803cf718001069b97b,sync_unique:,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},createdAt:2017-05-22T12:26:31.880Z,slug:facebook-messeger-settings-user-inputs,hidden:false,link_external:false,link_url:,title:User Inputs,isReference:true,type:basic,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b99e,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b97b,createdAt:2017-07-04T16:00:41.178Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:facebook-messeger-settings-domains-whitelist,type:basic,title:Domains Whitelist,isBodyEmpty:false,children:}},{_id:59fc42803cf718001069b93a,link_url:,slug:facebook-messenger-webhooks,title:Webhooks,isReference:true,order:6,parentDoc:null,api:{settings:,url:,auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}}},category:59fc42803cf718001069b926,sync_unique:,type:basic,createdAt:2016-12-19T16:35:33.469Z,hidden:false,link_external:false,isBodyEmpty:false,children:{_id:59fc42803cf718001069b945,sync_unique:,title:Message Received,hidden:false,isReference:true,link_url:,api:{auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:,examples:{codes:}},link_external:false,order:0,type:basic,category:59fc42803cf718001069b926,createdAt:2016-12-21T14:21:29.521Z,parentDoc:59fc42803cf718001069b93a,slug:facebook-messenger-webhooks-message-received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc508977dc0a0010000d78,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b93a,createdAt:2017-11-03T11:18:33.020Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:1,slug:facebook-messenger-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:59fc4fea77dc0a0010000d70,category:59fc42803cf718001069b926,parentDoc:59fc42803cf718001069b93a,createdAt:2017-11-03T11:15:54.106Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:facebook-messenger-webhooks-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b956,link_external:false,order:3,createdAt:2017-03-06T19:29:34.650Z,link_url:,type:basic,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,parentDoc:59fc42803cf718001069b93a,sync_unique:,title:Message Echo,category:59fc42803cf718001069b926,slug:facebook-messeger-webhooks-message-echo,hidden:false,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b954,category:59fc42803cf718001069b926,sync_unique:,hidden:false,link_url:,order:4,link_external:false,title:Postback Received,createdAt:2017-03-01T20:48:21.762Z,parentDoc:59fc42803cf718001069b93a,slug:facebook-messeger-webhooks-postback-received,type:basic,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b946,link_url:,title:Opt-in,slug:facebook-messeger-webhooks-opt-in,type:basic,api:{auth:required,method:get,params:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,url:},createdAt:2016-12-21T14:22:41.198Z,link_external:false,parentDoc:59fc42803cf718001069b93a,category:59fc42803cf718001069b926,hidden:false,order:5,sync_unique:,isReference:true,isBodyEmpty:false,children:}}},{_id:59fc42803cf718001069b927,__v:0,from_sync:false,order:6,project:584bd29609104d23007d9ec9,reference:true,slug:sms-1,createdAt:2016-12-10T11:25:16.080Z,sync:{url:,isSync:false},title:Mobile,version:59fc42803cf718001069b9ab,pages:{_id:59fc42803cf718001069b951,category:59fc42803cf718001069b927,createdAt:2017-01-07T10:48:18.254Z,link_external:false,parentDoc:null,slug:api-mobile,sync_unique:,hidden:false,link_url:,order:0,isReference:true,title:Mobile,api:{params:,results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,url:,auth:required,method:get},type:basic,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b952,createdAt:2017-01-07T14:37:29.298Z,link_url:,slug:mobile-messages,isReference:true,link_external:false,sync_unique:,type:basic,title:Messages,api:{auth:required,method:get,params:,results:{codes:{language:json,code:{},name:,status:200},{code:{},name:,status:400,language:json}},settings:,url:},category:59fc42803cf718001069b927,hidden:false,order:1,parentDoc:null,isBodyEmpty:false,children:{_id:5b0ec6af748b2c0003ee3910,category:59fc42803cf718001069b927,parentDoc:59fc42803cf718001069b952,createdAt:2018-05-30T15:43:43.786Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \mobile\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,name:},{status:400,language:json,code:{},name:}},auth:required,params:{_id:5b0ec704748b2c0003ee3d0a,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5b0ec704748b2c0003ee3d09,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get,apiSetting:5d8abde8192ec60031349232,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}}},isReference:true,order:0,slug:mobile-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:true,children:},{_id:59fc42803cf718001069b953,link_external:false,sync_unique:,isReference:true,slug:mobile-messages-text,category:59fc42803cf718001069b927,hidden:false,order:1,title:Text,type:endpoint,api:{examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1 (555) 857-6309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Phone number of the contact. All phone number formats are accepted. \u003cbr />\u003cbr />⚠ You always need to include international call prefix(https://en.wikipedia.org/wiki/List_of_international_call_prefixes).,default:,type:string,name:contact. phone_number},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum length of text depends on provider (MessageBird(https://support.messagebird.com/hc/en-us/articles/208739745-How-long-is-1-SMS-Message-) - 1377 characters).,default:,type:string,name:content.payload},results:{codes:{name:,status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \mobile\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},settings:,url:/v1/messages,auth:required,apiSetting:5d8abde8192ec60031349232},createdAt:2017-01-07T14:37:53.801Z,link_url:,parentDoc:59fc42803cf718001069b952,isBodyEmpty:false,children:},{_id:5b0fe1e571063b00037123fa,category:59fc42803cf718001069b927,parentDoc:59fc42803cf718001069b952,createdAt:2018-05-31T11:52:05.482Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:mobile-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:}},{_id:5b0fc3b371063b00037121d5,category:59fc42803cf718001069b927,createdAt:2018-05-31T09:43:15.521Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:mobile-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5b0fc3df3ebcea000311e5e1,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T09:43:59.223Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078759331238786\,\n \type\: \mobile\,\n \name\: \Amio Mobile\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\,\n \status_webhook_url\: \https://api.amio.io/webhook/messagebird/status/152775927128158\,\n \receive_webhook_url\: \https://api.amio.io/webhook/messagebird/message/6204630442/152811200579929\\n }\n }\n,name:OK}},apiSetting:5d8abde8192ec60031349232,auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:mobile-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b0fc8c43ebcea000311e682,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T10:04:52.391Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abde8192ec60031349232,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \mobile\,\n \name\: \Amio Mobile\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\,\n \status_webhook_url\: \https://api.amio.io/webhook/messagebird/status/152775927128158\,\n \receive_webhook_url\: \https://api.amio.io/webhook/messagebird/message/6204630442/152811200579929\\n }\n},language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d6a419d3741002afd4d9a},url:/v1/channels/{chanel_id},method:get},isReference:true,order:1,slug:mobile-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b0fca12572fa80003e5036b,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T10:10:26.864Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \type\: \mobile\,\n \name\: \Amio Mobile\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\\n }\n}}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \mobile\,\n \name\: \Amio Mobile\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\,\n \status_webhook_url\: \https://api.amio.io/webhook/messagebird/status/152776172104684\,\n \receive_webhook_url\: \https://api.amio.io/webhook/messagebird/message/6204630442/152811200579929\\n }\n},language:json,status:201}},apiSetting:5d8abde8192ec60031349232,auth:required,params:{_id:5a1c4077f512d400124699bb,ref:,in:body,required:true,desc:Channel type, `mobile`.,default:,type:string,name:type},{_id:5a1c459dacac6b001e666b52,ref:,in:body,required:false,desc:Name of the channel. If not set, it will be auto-generated.,default:,type:string,name:name},{_id:5d5d078c13c5490225e6a865,ref:,in:body,required:false,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:mobile-messages-text) requests will be accepted and sent as SMS. `test` - Send Message(ref:mobile-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message as SMS.,default:,type:string,name:mode},{_id:5a1c40a1c73b44001ed59949,ref:,in:body,required:false,desc:Webhook url where all channel events would be sent to.,default:,type:string,name:webhook.url},{_id:5e3c036291788a005bf228fa,ref:,in:body,required:false,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,default:,type:string,name:webhook.secret},{_id:5a1d322f61bdc2003611d6b5,ref:,in:body,required:true,desc:Name of the service provider. Following values are allowed: `messagebird`.,default:,type:string,name:provider.type},{_id:5b0fcc2c71063b000371228b,ref:,in:body,required:true,desc:Access token used for authorising requests to provider.,default:,type:string,name:provider.access_token},{_id:5b98c771305be800034e5306,ref:,in:body,required:true,desc:Signature key used for verifying that incoming webhook came from MessageBird. You can get this key in MessageBird administration(https://dashboard.messagebird.com/developers/settings).,default:,type:string,name:provider.signing_key},{_id:5b0fcc2c71063b000371228a,ref:,in:body,required:true,desc:Phone number registered at the provider or custom sender ID to be used as a message originator.,default:,type:string,name:provider.sender_id},url:/v1/channels,method:post},isReference:true,order:2,slug:mobile-channels-create-channel,type:endpoint,title:Create Channel,isBodyEmpty:false,children:},{_id:5b0fcd13c4e0380003372984,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T10:23:15.465Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abde8192ec60031349232,results:{codes:{status:200,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \mobile\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \provider\: {\n \type\: \messagebird\,\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\,\n \status_webhook_url\: \https://api.amio.io/webhook/messagebird/status/152775927128158\,\n \receive_webhook_url\: \https://api.amio.io/webhook/messagebird/message/6204630442/152811200579929\\n }\n},name:OK}},examples:{codes:{code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \provider\: {\n \sender_id\: \phonenumber\,\n \access_token\: \r3TniW2smgLGE3ntqHT\,\n \signing_key\: \GDVCrN9tgECUrkouzh4gyn7k\\n }\n},language:json}},auth:required,params:{_id:5a1d70ca721b9a0026bbd418,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a1c459dacac6b001e666b52,ref:,in:body,required:false,desc:Name of the channel. Might be an arbitrary name.,default:,type:string,name:name},{_id:5d5d07cffe803c006f399c3e,ref:,in:body,required:false,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:mobile-messages-text) requests will be accepted and sent as SMS. `test` - Send Message(ref:mobile-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message as SMS.,default:,type:string,name:mode},{_id:5a1c40a1c73b44001ed59949,ref:,in:body,required:false,desc:Webhook url where all channel events would be sent to.,default:,type:string,name:webhook.url},{_id:5b28cbcff11cd000039ca3f2,ref:,in:body,required:false,desc:Access token used for authorising requests to provider.,default:,type:string,name:provider.access_token},{_id:5b98c80e305be800034e5314,ref:,in:body,required:false,desc:Signature key used for verifying that incoming webhook came from MessageBird. You can get this key in MessageBird administration(https://dashboard.messagebird.com/developers/settings).,default:,type:string,name:provider.signing_key},{_id:5b28cbcff11cd000039ca3f1,ref:,in:body,required:false,desc:Phone number registered at the provider or custom sender ID to be used as a message originator.,default:,type:string,name:provider.sender_id},{_id:5e3c03a38171ea0059a7d1dc,ref:,in:body,required:false,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,default:,type:string,name:webhook.secret},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:mobile-channels-update-channel,type:endpoint,title:Update Channel,isBodyEmpty:false,children:},{_id:5b0fce6b71063b00037122b1,category:59fc42803cf718001069b927,parentDoc:5b0fc3b371063b00037121d5,createdAt:2018-05-31T10:28:59.778Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abde8192ec60031349232,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:mobile-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5b0fe338c4e0380003372b57,category:59fc42803cf718001069b927,createdAt:2018-05-31T11:57:44.013Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:mobile-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5b0fe3a9c4e0380003372b64,category:59fc42803cf718001069b927,parentDoc:5b0fe338c4e0380003372b57,createdAt:2018-05-31T11:59:37.603Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n }\n,name:OK}},apiSetting:5d8abde8192ec60031349232,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:mobile-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5b0fe5797d6ce90003071867,category:59fc42803cf718001069b927,parentDoc:5b0fe338c4e0380003372b57,createdAt:2018-05-31T12:07:21.492Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abde8192ec60031349232,results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n},name:OK}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:mobile-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5b0fe77c4b213d0003828e80,category:59fc42803cf718001069b927,parentDoc:5b0fe338c4e0380003372b57,createdAt:2018-05-31T12:15:56.251Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},apiSetting:5d8abde8192ec60031349232,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:mobile-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5b0ffd483ebcea000311eb38,category:59fc42803cf718001069b927,createdAt:2018-05-31T13:48:56.176Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:mobile-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5b471bd23dcb6a0003c6e9ac,category:59fc42803cf718001069b927,parentDoc:5b0ffd483ebcea000311eb38,createdAt:2018-07-12T09:13:54.108Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:mobile-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b0ffe0dc4e0380003372f58,category:59fc42803cf718001069b927,parentDoc:5b0ffd483ebcea000311eb38,createdAt:2018-05-31T13:52:13.291Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:mobile-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5ab4b65e187309001fe90732,category:59fc42803cf718001069b927,parentDoc:5b0ffd483ebcea000311eb38,createdAt:2018-03-23T08:10:06.331Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:mobile-webhooks-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:5b8d4e875a46ee000379283f,category:59fc42803cf718001069b927,parentDoc:5b0ffd483ebcea000311eb38,createdAt:2018-09-03T15:08:55.677Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:3,slug:mobile-message-echo,type:basic,title:Message Echo,isBodyEmpty:false,children:}}},{_id:5d5bf6b77913cf004e75718a,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2019-08-20T13:33:43.759Z,order:7,slug:rcs-business-messages-1,title:RCS Business Messages,__v:0,pages:{_id:5d5bf70c33015d003ba0fb9e,createdAt:2019-08-20T13:35:08.981Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-rbm,type:basic,title:RCS Business Messages,parentDoc:null,isBodyEmpty:false,children:},{_id:5d5bf7e2b60f6d0034540e81,createdAt:2019-08-20T13:38:42.157Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:rbm-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5d5bfc48cac552002aefd441,createdAt:2019-08-20T13:57:28.762Z,category:5d5bf6b77913cf004e75718a,parentDoc:5d5bf7e2b60f6d0034540e81,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \rbm\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,name:},{status:400,language:json,code:{},name:}},auth:required,params:{_id:5d5bfc48cac552002aefd443,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5d5bfc48cac552002aefd442,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:list-messages,type:endpoint,title:List Messages,isBodyEmpty:true,children:},{_id:5d5bf9161298cf015487983c,createdAt:2019-08-20T13:43:50.964Z,category:5d5bf6b77913cf004e75718a,parentDoc:5d5bf7e2b60f6d0034540e81,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \rbm\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},language:json,status:201}},auth:required,params:{_id:5d5bfbd7f20ff50052c03ae8,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5d5bfbd7f20ff50052c03ae7,ref:,in:body,required:true,desc:Phone number of the contact. All phone number formats are accepted. \u003cbr />\u003cbr />⚠ You always need to include international call prefix(https://en.wikipedia.org/wiki/List_of_international_call_prefixes).,default:,type:string,name:contact. phone_number},{_id:5d5bfbd7f20ff50052c03ae6,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:5d5bfbd7f20ff50052c03ae5,ref:,in:body,required:true,desc:Text to be sent encoded in UTF-8. The maximum size of a message is 250 KB.,default:,type:string,name:content.payload},url:/v1/messages,method:post,apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1 (555) 857-6309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}}},isReference:true,order:1,slug:rbm-messages-text,type:endpoint,title:Text,isBodyEmpty:false,children:},{_id:65bb5ff28ae912000f35c824,api:{method:post,url:/v1/messages/,auth:required,results:{codes:{name:,code:{},language:json,status:201},{name:,code:{},language:json,status:400}},params:{name:channel.id,type:string,enumValues:,default:,desc:id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33529},{name:contact.phone_number,type:string,enumValues:,default:,desc:Phone number of the contact. All phone number formats are accepted. \u003cbr />\u003cbr />⚠ You always need to include international call prefix(https://en.wikipedia.org/wiki/List_of_international_call_prefixes).,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33528},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33527},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. *Max size* 80 characters. However, you can use *up to 640 characters* if you use` text` with `buttons` only.,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33526},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:true,in:body,ref:,_id:65bb5d7ec65b840031c33525},examples:{codes:{code:{\n \channel\: {\n \id\: \{{amio_chat.channel.id}}\\n },\n \contact\: {\n \id\: \{{amio_chat.contact.id}}\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \text\: \For more info:\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Visit our website\,\n \payload\: \https://amio.io\\n },\n {\n \type\: \postback\,\n \title\: \About us\,\n \payload\: \postbackpayload\\n },\n {\n \type\: \phone\,\n \title\: \Call us\,\n \payload\: \+123456789\\n }\n \n }\n }\n},language:json}},apiSetting:5d8abe2605260200d46221ab},title:Structure,icon:,type:endpoint,slug:rbm-messages-structure,order:2,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:structure-copy,parentDoc:5d5bf7e2b60f6d0034540e81,category:5d5bf6b77913cf004e75718a,createdAt:2024-02-01T09:10:10.354Z,isBodyEmpty:true,children:}},{_id:5d5bfc6cd1b5f1026fdff395,createdAt:2019-08-20T13:58:04.131Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:rbm-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5d5bfde5d1b5f1026fdff3b9,createdAt:2019-08-20T14:04:21.314Z,category:5d5bf6b77913cf004e75718a,parentDoc:5d5bfc6cd1b5f1026fdff395,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels}},results:{codes:{name:,code:\n {\n \id\: \6555093381403135744\,\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \rbm\: {\n \agent_name\: \My Agent\,\n \agent_state\: \launched\,\n \region\: \europe\\n }\n }\n,language:json,status:200}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:rbm-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d5fe8abf49b52004ee2ba09,createdAt:2019-08-23T13:22:51.376Z,parentDoc:5d5bfc6cd1b5f1026fdff395,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6555093381403135744}},results:{codes:{status:200,language:json,code:{\n \id\: \6555093381403135744\,\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \rbm\: {\n \agent_name\: \My Agent\,\n \agent_state\: \launched\,\n \region\: \europe\\n }\n},name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5d5fe9119c402d0043962540},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:rbm-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d5fead3808f0500231c6c91,createdAt:2019-08-23T13:32:03.047Z,parentDoc:5d5bfc6cd1b5f1026fdff395,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{language:json,code:{\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \2EeSWemjm3715k7wfceP\\n },\n \rbm\: {\n \agent_name\: \ACME\,\n \region\: \europe\\n }\n}}},results:{codes:{name:,code:{\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \2EeSWemjm3715k7wfceP\\n },\n \rbm\: {\n \agent_name\: \ACME\,\n \agent_state\: \new\,\n \region\: \europe\\n }\n},language:json,status:201}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `rbm`.,required:true,in:body,ref:,_id:5d5fead3808f0500231c6c93},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be generated from `rbm.agent_name`.,required:false,in:body,ref:,_id:5d5fead3808f0500231c6c92},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904fb},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c04ee3eabf2001f28d91a},{name:rbm.agent_name,type:string,enumValues:,default:,desc:Name of the agent as it is shown to end users.,required:true,in:body,ref:,_id:5d5fedbfcade02001e3904fa},{name:rbm.region,type:string,enumValues:,default:,desc:Region is needed for Agent registration in RBM. Allowed regions are `asia_pacific`, `europe` and `north_america`.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904f9},url:/v1/channels,method:post},isReference:true,order:2,slug:rbm-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d5ff31f2a8488006b596f19,createdAt:2019-08-23T14:07:27.055Z,parentDoc:5d5bfc6cd1b5f1026fdff395,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:{\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \2EeSWemjm3715k7wfceP\\n },\n \rbm\: {\n \agent_name\: \ACME\,\n \agent_state\: \new\,\n \region\: \europe\\n }\n},language:json,status:201},{name:,code:{},language:json,status:400}},examples:{codes:{code:{\n \type\: \rbm\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \2EeSWemjm3715k7wfceP\\n },\n \rbm\: {\n \agent_name\: \ACME\,\n \agent_state\: \create_requested\,\n \region\: \europe\\n }\n},language:json}},apiSetting:5d8abe2605260200d46221ab,auth:required,params:{name:name,type:string,enumValues:,default:,desc:Name of the channel.,required:false,in:body,ref:,_id:5d5fead3808f0500231c6c92},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:rbm-messages-text) requests will be accepted and sent through RBM. `test` - Send Message(ref:rbm-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message through RBM.,required:false,in:body,ref:,_id:5d5ff3f0952aef003c2fa1e5},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904fb},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c0515d07a50002767306e},{name:rbm.agent_name,type:string,enumValues:,default:,desc:Name of the agent as it is shown to end users.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904fa},{name:rbm.agent_state,type:string,enumValues:,default:,desc:Agent state(ref:section-agent-state) describes whether your agent is registered in RBM and whether it is launched.\u003cbr />\u003cbr />Allowed values are:\u003cbr />- `create_requested` when Agent State is `new`\u003cbr />- `launch_requested` when Agent State is `created`,required:false,in:body,ref:,_id:5d5ff3f0952aef003c2fa1e4},{name:rbm.region,type:string,enumValues:,default:,desc:Region is needed for Agent registration in RBM. Allowed regions are `asia_pacific`, `europe` and `north_america`.\u003cbr />\u003cbr />Can only changed when Agent State is `new`.,required:false,in:body,ref:,_id:5d5fedbfcade02001e3904f9},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:rbm-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d5ff4ab60c5af01826b4633,createdAt:2019-08-23T14:14:03.801Z,parentDoc:5d5bfc6cd1b5f1026fdff395,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:204,language:json,code: ,name:}},examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6555093381403135744}},apiSetting:5d8abe2605260200d46221ab,auth:required,params:{_id:5d275245afab2100181cbe99,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:rbm-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5d5ff4f2aab1b200259c5b95,createdAt:2019-08-23T14:15:14.392Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:rbm-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5d5ff522b09b52003b2276a9,createdAt:2019-08-23T14:16:02.530Z,parentDoc:5d5ff4f2aab1b200259c5b95,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:rbm-contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5d5ff5cf8062560052f9623d,createdAt:2019-08-23T14:18:55.287Z,parentDoc:5d5ff4f2aab1b200259c5b95,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n},name:OK}},apiSetting:5d8abe2605260200d46221ab,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:rbm-channels-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5d5ff6515514ce00645414d0,createdAt:2019-08-23T14:21:05.297Z,parentDoc:5d5ff4f2aab1b200259c5b95,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe2605260200d46221ab,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:rbm-contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5d5ff6acaab1b200259c5bbf,createdAt:2019-08-23T14:22:36.889Z,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:rbm-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5d622b6e685c9000516a8218,createdAt:2019-08-25T06:32:14.412Z,parentDoc:5d5ff6acaab1b200259c5bbf,category:5d5bf6b77913cf004e75718a,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:rbm-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}}},{_id:5d273ddba3d7360243d48bab,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2019-07-11T13:47:07.460Z,order:8,slug:telegram,title:Telegram,__v:0,pages:{_id:5d273e1915b659001a5f7eb5,createdAt:2019-07-11T13:48:09.688Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-telegram,type:basic,title:Telegram,parentDoc:null,isBodyEmpty:false,children:},{_id:5d273fc59c6e3502d7823a6e,createdAt:2019-07-11T13:55:17.307Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:telegram-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5d49850cc4e4aa0159ff9d9b,createdAt:2019-08-06T13:47:56.598Z,category:5d273ddba3d7360243d48bab,parentDoc:5d273fc59c6e3502d7823a6e,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},apiSetting:5d8abe6e24e071001806f5d0,results:{codes:{name:,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \telegram\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,language:json,status:200},{name:,code:{},language:json,status:400}},auth:required,params:{_id:5b0ec704748b2c0003ee3d0a,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5b0ec704748b2c0003ee3d09,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:telegram-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:true,children:},{_id:5d275e041e20250044cc50e6,createdAt:2019-07-11T16:04:20.074Z,category:5d273ddba3d7360243d48bab,parentDoc:5d273fc59c6e3502d7823a6e,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6555093381403135744\\n },\n \contact\: {\n \id\: \6555112211957436097\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},results:{codes:{status:201,language:json,code:{\n \id\: \6555113982310240129\,\n \channel\: {\n \id\: \6555093381403135744\,\n \type\: \telegram\\n },\n \contact\: {\n \id\: \6555112211957436097\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:}},auth:required,params:{_id:5d275e2c7c55c4002aa2b452,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5d275e43922f8e003d9e1e6d,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:5d275e56a564c200183d3511,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:5d275e6e9c6e3502d7823ee9,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 4096 characters.,default:,type:string,name:content.payload},url:/v1/messages,method:post},isReference:true,order:1,slug:telegram-messages-text,type:endpoint,title:Text,isBodyEmpty:false,children:},{_id:66557b4203f0c7000fd31b01,api:{method:get,url:,auth:required,results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},settings:,examples:{codes:},params:},title:Quick Replies,icon:,type:basic,slug:quick-replies-copy,order:2,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d273fc59c6e3502d7823a6e,category:5d273ddba3d7360243d48bab,createdAt:2024-05-28T06:35:46.390Z,mdx:{},isBodyEmpty:false,children:},{_id:66557b24c024240013cf5de9,api:{method:post,url:/v1/messages/,auth:required,apiSetting:5e426de8bedf32005fb53c27,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad with smoked eggplant and zuchhini and dried tomatoes\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.title,type:string,enumValues:,default:,desc:Title of the message. **Max size** 80 characters. Title has to be specified with one more additional attribute: `text`, `image_url` or `buttons`. You can also omit the title attribute and use only `text` and `buttons` attributes.,required:false,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. **Max size** 80 characters. However, you can use **up to 640 characters** if you use text with buttons only.,required:false,in:body,ref:,_id:585b96556399952d00e0ac38},{name:content.payload.image_url,type:string,enumValues:,default:,desc:Url of an image to be displayed. Image ratio is 1.91:1.,required:false,in:body,ref:,_id:585b96556399952d00e0ac37},{name:content.payload.item_url,type:string,enumValues:,default:,desc:Url which is opened when the message is tapped.,required:false,in:body,ref:,_id:585b96556399952d00e0ac36},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown below the message. Limited to 3 buttons. See Buttons(ref:facebook-messenger-messages-buttons) chapter for more details.,required:false,in:body,ref:,_id:585b96556399952d00e0ac35},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:amio-chat-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a58e527791cac001c857652}},title:Structure,icon:,type:endpoint,slug:structure-copy,order:3,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d273fc59c6e3502d7823a6e,category:5d273ddba3d7360243d48bab,createdAt:2024-05-28T06:35:16.506Z,isBodyEmpty:false,children:},{_id:66557b3803f0c7000fd31af8,api:{method:post,url:/v1/messages,auth:required,apiSetting:5e426a35dd81f5001b88b66e,settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108099701\,\n \channel\: {\n \id\: \6456078759331248741\,\n \type\: \amio_chat\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},name:}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331248741\\n },\n \contact\: {\n \id\: \6456078781510715474\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `image`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.url,type:string,enumValues:,default:,desc:Url of the image to be sent.,required:true,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.quick_replies,type:array_object,enumValues:,default:,desc:Quick Replies(ref:amio-chat-messages-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,required:false,in:body,ref:,_id:5e4267fc21a9040154db2bf6},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:amio-chat-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5e42684b5e1c780019935aa0}},title:Image,icon:,type:endpoint,slug:image-copy,order:4,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d273fc59c6e3502d7823a6e,category:5d273ddba3d7360243d48bab,createdAt:2024-05-28T06:35:36.260Z,isBodyEmpty:true,children:},{_id:66557b75b7406e002c572b3e,api:{method:post,url:/v1/messages/,auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.id,type:string,enumValues:,default:,desc:Id of the contact. Id is unique across channels and is generated by Amio.,required:true,in:body,ref:recipient,_id:5854206ce6afe623008aa9b8},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `video`.,required:true,in:body,ref:,_id:585a7b977904db2d009b5983},{name:content.payload.url,type:string,enumValues:,default:,desc:Url of the video to be sent. Max size is 25 MB.,required:true,in:body,ref:,_id:585a7b3e7904db2d009b5977},{name:content.quick_replies,type:array_object,enumValues:,default:,desc:Quick Replies(ref:facebook-quick-replies) enrich the message with buttons that are dismissed as soon as user taps one.,required:false,in:body,ref:,_id:59874a6ac66549000f043b40},{name:metadata,type:object,enumValues:,default:,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,required:false,in:body,ref:,_id:5a16a3d6f7b5a0001e036bf6},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},name:}},settings:,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},language:json}},apiSetting:5d8e9b7719f4740011d43b89},title:Video,icon:,type:endpoint,slug:video-copy,order:5,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:,parentDoc:5d273fc59c6e3502d7823a6e,category:5d273ddba3d7360243d48bab,createdAt:2024-05-28T06:36:37.280Z,isBodyEmpty:false,children:}},{_id:5d2748d11b6a1e02e31542e5,createdAt:2019-07-11T14:33:53.750Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:telegram-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5d274d627088ce004c19ecfa,createdAt:2019-07-11T14:53:22.676Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels}},results:{codes:{name:,code:\n {\n \id\: \6555093381403135744\,\n \type\: \telegram\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\,\n \name\: \Amio.io\,\n \username\: \amio_io_bot\\n }\n }\n,language:json,status:200}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:telegram-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d274fc5afab2100181cbe38,createdAt:2019-07-11T15:03:33.791Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6555093381403135744}},results:{codes:{status:200,language:json,code:{\n \id\: \6555093381403135744\,\n \type\: \telegram\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\,\n \name\: \Amio.io\,\n \username\: \amio_io_bot\\n }\n},name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5d274fc5afab2100181cbe39},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:telegram-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d2749522c897102b8a919dc,createdAt:2019-07-11T14:36:02.523Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:{\n \id\: \6555093381403135744\,\n \type\: \telegram\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\,\n \name\: \Amio.io\,\n \username\: \amio_io_bot\\n }\n},language:json,status:201}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `telegram`.,required:true,in:body,ref:,_id:5d274bf5a3d7360243d48d54},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, prefilled with the connected Telegram Bot name.,required:false,in:body,ref:,_id:5d274bf5a3d7360243d48d52},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5d274bf5a3d7360243d48d51},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c054d91c8d00031e15272},{name:telegram.access_token,type:string,enumValues:,default:,desc:Telegram Bot access token. It has to be unique since Telegram Bot account can be only assigned to one channel. You received this token when you created your Telegram Bot.,required:true,in:body,ref:,_id:5d274bf5a3d7360243d48d53},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d11a2fd24750251b7c223},url:/v1/channels,method:post,apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:json,code:{\n \type\: \telegram\,\n \name\: \Amio.io\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\\n }\n}}}},isReference:true,order:2,slug:telegram-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d27519c473480005c0aa9fa,createdAt:2019-07-11T15:11:24.656Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:json,code:{\n \name\: \New Name\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n }\n}}},results:{codes:{status:200,language:json,code:{\n \id\: \6555093381403135744\,\n \type\: \telegram\,\n \name\: \New Name\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \telegram\: {\n \access_token\: \123456789:ATRY9Bwa0raXG-rsIUUzPpwgtdsdhhy7PY\,\n \name\: \Amio.io\,\n \username\: \amio_io_bot\\n }\n},name:}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5d27519c473480005c0aa9fb},{name:name,type:string,enumValues:,default:,desc:Name of the channel.,required:false,in:body,ref:,_id:5d5d11edde9a8d01034119e2},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d11edde9a8d01034119e1},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5d5d11edde9a8d01034119e0},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c05d67eb0110011070dd9},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:telegram-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d275245afab2100181cbe98,createdAt:2019-07-11T15:14:13.536Z,category:5d273ddba3d7360243d48bab,parentDoc:5d2748d11b6a1e02e31542e5,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6555093381403135744}},results:{codes:{status:204,language:json,code: ,name:}},auth:required,params:{_id:5d275245afab2100181cbe99,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:telegram-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5d274f434c171c004a97bfa0,createdAt:2019-07-11T15:01:23.481Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:telegram-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5d2761251d33ed048e33ebdb,createdAt:2019-07-11T16:17:41.855Z,category:5d273ddba3d7360243d48bab,parentDoc:5d274f434c171c004a97bfa0,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6555093381403135744/contacts}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6555112211957436097\,\n \name\: \6555112211957436097\\n }\n,name:}},auth:required,params:{_id:5d2761251d33ed048e33ebde,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5d2761251d33ed048e33ebdd,ref:,in:query,required:false,desc:Maximum number of results to be returned. Cannot be more than 100.,default:,type:int,name:max},{_id:5d2761251d33ed048e33ebdc,ref:,in:query,required:false,desc:Skip first N results.,default:,type:int,name:offset},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:telegram-contacts-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5d27618b2c897102b8a91d42,createdAt:2019-07-11T16:19:23.983Z,category:5d273ddba3d7360243d48bab,parentDoc:5d274f434c171c004a97bfa0,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6555093381403135744/contacts/6555112211957436097}},results:{codes:{status:200,language:json,code:{\n \id\: \6555112211957436097\,\n \name\: \6555112211957436097\\n},name:}},auth:required,params:{_id:5d276209a3d7360243d490a2,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5d276209a3d7360243d490a1,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:telegram-contacts-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5d2762251d33ed048e33ec07,createdAt:2019-07-11T16:21:57.617Z,category:5d273ddba3d7360243d48bab,parentDoc:5d274f434c171c004a97bfa0,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abe6e24e071001806f5d0,examples:{codes:{language:curl,code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6555093381403135744/contacts/6555112211957436097}},results:{codes:{status:204,language:json,code: ,name:}},auth:required,params:{_id:5d27626a4c171c004a97c287,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5d27626a4c171c004a97c286,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:telegram-contacts-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5d275c6238d460003eaa089d,createdAt:2019-07-11T15:57:22.238Z,category:5d273ddba3d7360243d48bab,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:telegram-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5d275c909c6e3502d7823e9f,createdAt:2019-07-11T15:58:08.193Z,category:5d273ddba3d7360243d48bab,parentDoc:5d275c6238d460003eaa089d,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:telegram-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:6666e0ca7a17cb0050c15777,api:{method:get,url:,auth:required,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},params:,examples:{codes:}},title:Message Echo,icon:,type:basic,slug:telegram-webhooks-message-echo,order:1,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:message-echo-copy,parentDoc:5d275c6238d460003eaa089d,category:5d273ddba3d7360243d48bab,createdAt:2024-06-10T11:17:30.990Z,isBodyEmpty:false,children:},{_id:6666dfa86fbeb30053429d95,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:,examples:{codes:}},title:Postback Received,icon:,type:basic,slug:telegram-webhooks-postback-received,order:2,isReference:true,deprecated:false,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:postback-received,parentDoc:5d275c6238d460003eaa089d,category:5d273ddba3d7360243d48bab,createdAt:2024-06-10T11:12:40.164Z,isBodyEmpty:false,children:}}},{_id:59fc42803cf718001069b929,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,order:9,slug:viber,__v:0,reference:true,createdAt:2017-04-05T09:40:24.039Z,from_sync:false,title:Viber Bot,pages:{_id:59fc42803cf718001069b95c,hidden:false,isReference:true,order:0,slug:api-viber,title:Viber Bot,link_external:false,link_url:,api:{results:{codes:{status:200,language:json,code:{},name:},{code:{},name:,status:400,language:json}},auth:required,params:,url:,method:get},sync_unique:,type:basic,createdAt:2017-04-05T09:41:39.622Z,parentDoc:null,category:59fc42803cf718001069b929,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b95d,link_url:,order:1,createdAt:2017-04-05T11:13:04.716Z,hidden:false,isReference:true,type:basic,slug:viber-messages,sync_unique:,title:Messages,link_external:false,parentDoc:null,api:{url:,method:get,results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:},category:59fc42803cf718001069b929,isBodyEmpty:false,children:{_id:5a70733ec3cfa000542fbd59,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b95d,createdAt:2018-01-30T13:29:34.559Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078781510718339\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078759331238786\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,name:}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{_id:5a7071e1b3c9580024d1a2f5,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a7071e1b3c9580024d1a2f4,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:viber-messages-list-messages,type:endpoint,title:List Messages,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b95e,api:{settings:,url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 320 characters.,default:,type:string,name:content.payload},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:null}},apiSetting:5d8abeb7e83f7e0024e19041},parentDoc:59fc42803cf718001069b95d,sync_unique:,type:endpoint,category:59fc42803cf718001069b929,isReference:true,link_external:false,link_url:,slug:viber-messages-text,title:Text,hidden:false,order:1,createdAt:2017-04-05T11:19:56.437Z,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b95f,hidden:false,link_external:false,order:2,parentDoc:59fc42803cf718001069b95d,slug:viber-messages-image,category:59fc42803cf718001069b929,api:{url:/v1/messages,auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:payload.url},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},name:}},settings:,apiSetting:5d8ea08fd89cd90046594b52},createdAt:2017-04-05T11:26:16.769Z,title:Image,isReference:true,link_url:,sync_unique:,type:endpoint,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b960,createdAt:2017-04-05T11:26:30.710Z,order:3,api:{auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `video`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the video to be sent. Allowed formats are **MP4** and **H264**. Max size is 50 MB. Max duration is 180 seconds.,default:,type:string,name:payload.url},results:{codes:{code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4\\n }\n }\n},name:,status:201,language:json}},settings:,url:/v1/messages,apiSetting:5d8ea140589ec60039e75dd9},hidden:false,parentDoc:59fc42803cf718001069b95d,slug:viber-messages-video,sync_unique:,category:59fc42803cf718001069b929,isReference:true,link_url:,title:Video,type:endpoint,link_external:false,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b961,type:endpoint,slug:viber-messages-file,hidden:false,isReference:true,link_url:,parentDoc:59fc42803cf718001069b95d,createdAt:2017-04-05T11:27:29.639Z,title:File,category:59fc42803cf718001069b929,link_external:false,order:4,sync_unique:,api:{url:/v1/messages,auth:required,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \https://example.com/file.pdf\\n }\n }\n}}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `file`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the file to be sent.,default:,type:string,name:payload.url},results:{codes:{status:201,name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \https://example.com/file.pdf\\n }\n }\n},language:json}},settings:,apiSetting:5d8ea1e2255ef80065c71ab4},isBodyEmpty:false,children:},{_id:59fc42803cf718001069b962,api:{results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \facebook_messenger\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},settings:,url:/v1/messages,auth:required,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},method:post,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `structure`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:false,desc:Title of the message. It is displayed on one line and the text is truncated with ellipsis (three dots in the end) if exceeds the line. You can usually fit up to **20 characters**.,default:,type:string,name:payload.title},{_id:585b96556399952d00e0ac38,ref:,in:body,required:false,desc:Message text. It is displayed on 3 lines if zero or one button is used or on one line if more buttons are used. Thats enough space for approximately **65 characters** or **22 characters** respectively.,default:,type:string,name:payload.text},{_id:585b96556399952d00e0ac37,ref:,in:body,required:false,desc:Url of an image to be displayed. Image ratio is 1.91:1.,default:,type:string,name:payload.image_url},{_id:585b96556399952d00e0ac36,ref:,in:body,required:false,desc:Url which is opened when the message is tapped.,default:,type:string,name:payload.item_url},{_id:585b96556399952d00e0ac35,ref:,in:body,required:false,desc:Buttons to be shown below the message. Limitted to 3 buttons. See Buttons(ref:viber-messages-buttons) chapter for more details.,default:,type:array_object,name:payload.buttons},{_id:5a58e55c086a05001c43238d,ref:,in:body,required:false,desc:Metadata(ref:viber-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:viber-webhooks-message-echo) webhook.,default:,type:string,name:metadata},apiSetting:5d8ea25e31d0eb00385066dc},hidden:false,type:endpoint,parentDoc:59fc42803cf718001069b95d,slug:viber-messages-structure-viber,isReference:true,link_external:false,link_url:,sync_unique:,title:Structure,category:59fc42803cf718001069b929,createdAt:2017-04-05T11:27:42.524Z,order:5,isBodyEmpty:false,children:},{_id:5a58e584086a05001c432390,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b95d,createdAt:2018-01-12T16:42:44.601Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ea29a4794a30018945b36,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n },\n {\n \title\: \Beef burger\,\n \text\: \12.0 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-2\\n }\n \n }\n \n }\n},language:json}},settings:,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: \n {\n \buttons\: \n {\n \payload\: \https://example.com/daily-menu/food-1\,\n \type\: \url\,\n \title\: \Show Details\\n }\n ,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \text\: \9.5 €\,\n \title\: \Leaf salad\\n },\n {\n \buttons\: \n {\n \payload\: \https://example.com/daily-menu/food-2\,\n \type\: \url\,\n \title\: \Show Details\\n }\n ,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/9/9b/YOKOSUKA-NAVY-BURGER-TSUNAMI.JPG\,\n \item_url\: \https://example.com/daily-menu\,\n \text\: \12.0 €\,\n \title\: \Beef burger with Coleslaw salad\\n }\n \n }\n},language:json,status:201}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `structure`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:false,desc:Title of the message. It is displayed on one line and the text is truncated with ellipsis (three dots in the end) if exceeds the line. You can usually fit up to **20 characters**.,default:,type:string,name:payload.title},{_id:585b96556399952d00e0ac38,ref:,in:body,required:false,desc:Message text. It is displayed on 3 lines if zero or one button is used or on one line if more buttons are used. Thats enough space for approximately **65 characters** or **22 characters** respectively.,default:,type:string,name:payload.text},{_id:585b96556399952d00e0ac37,ref:,in:body,required:false,desc:Url of an image to be displayed. Image ratio is 1.91:1.,default:,type:string,name:payload.image_url},{_id:585b96556399952d00e0ac36,ref:,in:body,required:false,desc:Url which is opened when the message is tapped.,default:,type:string,name:payload.item_url},{_id:585b96556399952d00e0ac35,ref:,in:body,required:false,desc:Buttons to be shown below the message. Limitted to 3 buttons. See Buttons(ref:viber-messages-buttons) chapter for more details.,default:,type:array_object,name:payload.buttons},{_id:5a58e55c086a05001c43238d,ref:,in:body,required:false,desc:Metadata(ref:viber-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:viber-webhooks-message-echo) webhook.,default:,type:string,name:metadata},url:/v1/messages,method:post},isReference:true,order:6,slug:viber-messages-structure-horizontal-scroll,type:endpoint,title:Structure - Horizontal Scroll,isBodyEmpty:false,children:},{_id:5a58df9c2e799c003047b900,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b95d,createdAt:2018-01-12T16:17:32.267Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:7,slug:viber-messages-buttons,type:basic,title:Buttons,isBodyEmpty:false,children:},{_id:5a16a4a59610050012c4a2f8,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b95d,createdAt:2017-11-23T10:36:21.980Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:8,slug:viber-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:}},{_id:5a1d683121ea8a00123be93c,category:59fc42803cf718001069b929,createdAt:2017-11-28T13:44:17.392Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:viber-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5a1d6862983d8e0012708c7c,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T13:45:06.722Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abeb7e83f7e0024e19041,results:{codes:{name:OK,code:\n {\n \id\: \6456078759331238786\,\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber\: {\n \name\: \Amio\,\n \category\: \Companies, Brands & Products\,\n \uri\: \amioio\,\n \access_token\: \46c9501a7eefc1ab\\n }\n }\n,language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:viber-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d6a02721b9a0026bbd37c,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T13:52:02.202Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber\: {\n \name\: \Amio\,\n \category\: \Companies, Brands & Products\,\n \uri\: \amioio\,\n \access_token\: \46c9501a7eefc1ab\\n }\n},language:json,status:200}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d6a419d3741002afd4d9a},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:viber-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d6ab767d310001245c5c4,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T13:55:03.679Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abeb7e83f7e0024e19041,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber\: {\n \name\: \Amio\,\n \category\: \Companies, Brands & Products\,\n \uri\: \amioio\,\n \access_token\: \46c9501a7eefc1ab\\n }\n},language:json,status:201}},examples:{codes:{language:json,code:{\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \viber\: {\n \access_token\: \46c9501a7eefc1ab\\n }\n}}},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `viber`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be filled with connected Viber Bot name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d129518349a002cb91719},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c05f9afbdba00428837a2},{name:viber.access_token,type:string,enumValues:,default:,desc:Viber Bot account access token. It has to be unique as Viber Bot account can be assigned only to one channel. You receive this token from Viber.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b5},url:/v1/channels,method:post},isReference:true,order:2,slug:viber-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d706821ea8a00123bea7d,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T14:19:20.206Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n }\n},language:json}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber\: {\n \name\: \Amio\,\n \category\: \Companies, Brands & Products\,\n \uri\: \amioio\,\n \access_token\: \46c9501a7eefc1ab\\n }\n},language:json,status:200}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d70ca721b9a0026bbd418},{name:name,type:string,enumValues:,default:,desc:Name of the channel. Might be an arbitrary name.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. Only `production` mode is allowed.,required:false,in:body,ref:,_id:5d5d12d74670d90037f7e91b},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,required:false,in:body,ref:,_id:5e3c061a2de62e0018933f3b},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:viber-channels-update-channel,type:endpoint,title:Update Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a1d714f983d8e0012708d99,category:59fc42803cf718001069b929,parentDoc:5a1d683121ea8a00123be93c,createdAt:2017-11-28T14:23:11.267Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:viber-channels-delete-channel,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5a13197d45769d002674f236,category:59fc42803cf718001069b929,createdAt:2017-11-20T18:05:49.125Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:viber-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5a1319d0b57953001cece1ac,category:59fc42803cf718001069b929,parentDoc:5a13197d45769d002674f236,createdAt:2017-11-20T18:07:12.011Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abeb7e83f7e0024e19041,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\,\n \locale\: \de_DE\,\n \photo_url\: \https://scontent.xx.fbcdn.net/v/t1.0-1/541992_511761562179706_48931455_n.jpg?oh1b30d9f950c70b19cf99ef8ea81a169e&oe5A5108B3\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:viber-list-contacts,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5a131a1745769d002674f239,category:59fc42803cf718001069b929,parentDoc:5a13197d45769d002674f236,createdAt:2017-11-20T18:08:23.712Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},results:{codes:{name:OK,code:{\n \id\: \6456078781510718339\,\n \name\: \Dietrich Bonhoeffer\,\n \locale\: \de_DE\,\n \photo_url\: \https://scontent.xx.fbcdn.net/v/t1.0-1/541992_511761562179706_48931455_n.jpg?oh1b30d9f950c70b19cf99ef8ea81a169e&oe5A5108B3\\n},language:json,status:200}},apiSetting:5d8abeb7e83f7e0024e19041,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:viber-get-contact,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5a131a23ddc95100120c4a66,category:59fc42803cf718001069b929,parentDoc:5a13197d45769d002674f236,createdAt:2017-11-20T18:08:35.265Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8abeb7e83f7e0024e19041,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:viber-delete-contact,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:59fc42803cf718001069b964,link_external:false,parentDoc:null,createdAt:2017-04-05T12:38:42.588Z,hidden:false,link_url:,slug:viber-webhooks,type:basic,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,category:59fc42803cf718001069b929,order:4,sync_unique:,title:Webhooks,isBodyEmpty:false,children:{_id:59fc42803cf718001069b965,link_external:false,hidden:false,sync_unique:,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},createdAt:2017-04-05T12:38:51.319Z,slug:viber-webhooks-message-received,title:Message Received,isReference:true,link_url:,order:0,parentDoc:59fc42803cf718001069b964,type:basic,category:59fc42803cf718001069b929,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5a467b576b2de2001c5838ff,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b964,createdAt:2017-12-29T17:28:55.386Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:1,slug:viber-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5a467da86b2de2001c583922,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b964,createdAt:2017-12-29T17:38:48.526Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:2,slug:viber-webhooks-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:5b0fff057d6ce90003071a32,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b964,createdAt:2018-05-31T13:56:21.101Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:3,slug:viber-webhooks-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:59fc42803cf718001069b966,order:4,sync_unique:,link_url:,title:Message Echo,type:basic,category:59fc42803cf718001069b929,createdAt:2017-04-05T13:13:26.838Z,hidden:false,isReference:true,link_external:false,parentDoc:59fc42803cf718001069b964,slug:viber-webhooks-message-echo,api:{results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isBodyEmpty:false,children:},{_id:5a5a63a391d40f001e6e08a3,category:59fc42803cf718001069b929,parentDoc:59fc42803cf718001069b964,createdAt:2018-01-13T19:53:07.964Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:viber-webhooks-postback-received,type:basic,title:Postback Received,isBodyEmpty:false,children:}}},{_id:5b6d89a09d346300038baf55,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2018-08-10T12:48:32.519Z,from_sync:false,order:10,slug:viber-business-messages,title:Viber Business Messages,__v:0,pages:{_id:5b717d825b81530003aa7adf,category:5b6d89a09d346300038baf55,parentDoc:null,createdAt:2018-08-13T12:45:54.204Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-viber-business-messages,type:basic,title:Viber Business Messages,isBodyEmpty:false,children:},{_id:5b6d89da8ffb3900032cd5e4,category:5b6d89a09d346300038baf55,createdAt:2018-08-10T12:49:30.685Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:viber-business-messages-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5b6d8ef19d346300038baf8d,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:11:13.946Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},results:{codes:{name:,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,language:json,status:200}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a7071e1b3c9580024d1a2f5},{name:contact_id,type:string,enumValues:,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5a7071e1b3c9580024d1a2f4},{name:max,type:int,enumValues:,default:10,desc:Maximum number of messages to be listed. Values larger than 100 are accepted but the list will never contain more than 100 messages.,required:false,in:query,ref:,_id:60c89904dae32b00230cf89f},{name:offset,type:int,enumValues:,default:0,desc:Offset of the starting position in the message list.,required:false,in:query,ref:,_id:60c89904dae32b00230cf89e},{name:since,type:string,enumValues:,default:unlimited,desc:Allows filtering messages by date. Must be in ISO 8601 format.,required:false,in:query,ref:,_id:60c89904dae32b00230cf89d},{name:before,type:string,enumValues:,default:unlimited,desc:Allows filtering messages by date. Must be in ISO 8601 format.,required:false,in:query,ref:,_id:60c89904dae32b00230cf89c},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:0,slug:viber-business-list-messages,type:endpoint,title:List Messages,previousSlug:,isBodyEmpty:false,children:},{_id:5b6d8eff9218840003992b61,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:11:27.442Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:null}},examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1-555-857-6309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},settings:,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Phone number of the contact.,default:,type:string,name:contact.phone_number},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 1000 characters.,default:,type:string,name:content.payload},url:/v1/messages,method:post},isReference:true,order:1,slug:viber-business-messages-text,type:endpoint,title:Text,isBodyEmpty:false,children:},{_id:5b6d8f0873acbe000364a4d7,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:11:36.046Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8e9f9ef9188300738106b5,settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},name:}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1-555-857-6309\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Phone number of the contact.,default:,type:string,name:contact.phone_number},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:payload.url},url:/v1/messages,method:post},isReference:true,order:2,slug:viber-business-messages-image,type:endpoint,title:Image,isBodyEmpty:false,children:},{_id:5b6d8f16d1d33e0003f0c59d,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:11:50.759Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ea00cfb26fa001c90b78d,examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1-555-857-6309\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},language:json}},settings:,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\\n\t},\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \title\: \Leaf salad\,\n \text\: \9.5 €\,\n \image_url\: \https://upload.wikimedia.org/wikipedia/commons/f/fa/Fish_-lunch.jpg\,\n \item_url\: \https://example.com/daily-menu\,\n \buttons\: \n {\n \type\: \url\,\n \title\: \Show Details\,\n \payload\: \https://example.com/daily-menu/food-1\\n }\n \n }\n }\n},name:}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:recipient,in:body,required:true,desc:Phone number of the contact.,default:,type:string,name:contact.phone_number},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `structure`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:false,desc:Title of the message. Max **80 characters**.,default:,type:string,name:payload.title},{_id:585b96556399952d00e0ac38,ref:,in:body,required:false,desc:Message text. Max **900 characters**, text is wrapped to lines.,default:,type:string,name:payload.text},{_id:585b96556399952d00e0ac37,ref:,in:body,required:false,desc:Url of an image to be displayed. Image ratio is 1.91:1.,default:,type:string,name:payload.image_url},{_id:585b96556399952d00e0ac36,ref:,in:body,required:false,desc:Url which is opened when the message is tapped.,default:,type:string,name:payload.item_url},{_id:585b96556399952d00e0ac35,ref:,in:body,required:false,desc:Buttons to be shown below the message. Viber Business Messages only support 1 button.,default:,type:array_object,name:payload.buttons},{_id:5a58e55c086a05001c43238d,ref:,in:body,required:false,desc:Metadata(ref:viber-business-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:viber-business-webhooks-message-echo) webhook.,default:,type:string,name:metadata},url:/v1/messages,method:post},isReference:true,order:3,slug:viber-business-messages-structure,type:endpoint,title:Structure,isBodyEmpty:false,children:},{_id:5b6d8f418ffb3900032cd642,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:12:33.580Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:viber-business-messages-buttons,type:basic,title:Buttons,isBodyEmpty:false,children:},{_id:5b6d8f4a73acbe000364a4e4,category:5b6d89a09d346300038baf55,parentDoc:5b6d89da8ffb3900032cd5e4,createdAt:2018-08-10T13:12:42.400Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:viber-business-messages-metadata,type:basic,title:Metadata,isBodyEmpty:false,children:}},{_id:5b6d981173acbe000364a59e,category:5b6d89a09d346300038baf55,createdAt:2018-08-10T13:50:09.359Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:viber-business-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5b6d98219d346300038bb011,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:50:25.041Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\,\n \name\: \Viber Business Messages - Example\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT24H\,\n \approved\: true,\n }\n }\n,name:OK}},apiSetting:5d8ac09de7b73f03363d49cc,auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:viber-business-channels-list,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b6d98299d346300038bb012,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:50:33.082Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,results:{codes:{status:200,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT24H\,\n \approved\: true,\n }\n},name:OK}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},auth:required,params:{name:channel_id,type:string,enumValues:,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:5a1d6a419d3741002afd4d9a},url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:viber-business-channels-get,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b6d98319d346300038bb013,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:50:41.748Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:json,code:{\n \type\: \viber_business_messages\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT1H\,\n }\n}}},results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT1H\,\n \approved\: false,\n }\n},language:json,status:201}},apiSetting:5d8ac09de7b73f03363d49cc,auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `viber_business_messages`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be generated automatically.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:viber-business-messages-text) requests will be accepted and sent through Viber network. `sandbox ` - Send Message(ref:viber-business-messages-text) requests will be sent using common Amio Sender ID. Messages sent are not charged but number of messages sent is limited. `test` - Send Message(ref:viber-business-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message through Viber.,required:false,in:body,ref:,_id:5d5d13404670d90037f7e92e},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c064b600631001ca317db},{name:viber_business_messages.sender_id,type:string,enumValues:,default:,desc:The Sender ID will be shown in the Viber app as a sender of the message. You wont be able to change the Sender ID once its registered with Viber.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b5},{name:viber_business_messages.default_message_ttl,type:string,enumValues:,default:PT24H,desc:Message validity period. If the message couldnt be delivered within this period, it will be discarded. Value should be provided in (ISO 8601 duration(https://en.wikipedia.org/wiki/ISO_8601#Durations)).,required:false,in:body,ref:,_id:5c73e9f8d685480024df009f},url:/v1/channels,method:post},isReference:true,order:2,slug:viber-business-channels-create,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b6d98399d346300038bb014,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:50:49.967Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,results:{codes:{name:OK,code:{\n \id\: \6456078759331238786\,\n \type\: \viber_business_messages\,\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \viber_business_messages\: {\n \sender_id\: \Example\,\n \default_message_ttl\: \PT20M\,\n \approved\: false,\n }\n},language:json,status:200}},examples:{codes:{language:json,code:{\n \name\: \Amio\,\n \mode\: \production\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \viber_business_messages\: {\n \default_message_ttl\: \PT20M\,\n }\n}}},auth:required,params:{_id:5a1d70ca721b9a0026bbd418,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a1c459dacac6b001e666b52,ref:,in:body,required:false,desc:Name of the channel. Might be an arbitrary name.,default:,type:string,name:name},{_id:5d5d147bb8da6d006cabaea8,ref:,in:body,required:false,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:viber-business-messages-text) requests will be accepted and sent through Viber network. `sandbox ` - Send Message(ref:viber-business-messages-text) requests will be sent using common Amio Sender ID. Messages sent are not charged but number of messages sent is limited. `test` - Send Message(ref:viber-business-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message through Viber.,default:,type:string,name:mode},{_id:5a1c40a1c73b44001ed59949,ref:,in:body,required:false,desc:Webhook url where all channel events would be sent to.,default:,type:string,name:webhook.url},{_id:5e3c06833eabf2001f28d924,ref:,in:body,required:false,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters.,default:,type:string,name:webhook.secret},{_id:5c73ea4eaa37f400629dd8e0,ref:,in:body,required:false,desc:Message validity period. If the message couldnt be delivered within this period, it will be discarded. Value should be provided in (ISO 8601 duration(https://en.wikipedia.org/wiki/ISO_8601#Durations)).,default:PT24H,type:string,name:viber_business_messages.default_message_ttl},url:/v1/channels/{channel_id},method:patch},isReference:true,order:3,slug:viber-business-channels-update,type:endpoint,title:Update Channel,isBodyEmpty:false,children:},{_id:5b6d984473acbe000364a5a0,category:5b6d89a09d346300038baf55,parentDoc:5b6d981173acbe000364a59e,createdAt:2018-08-10T13:51:00.350Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel to be deleted.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id},method:delete},isReference:true,order:4,slug:viber-business-channels-delete,type:endpoint,title:Delete Channel,isBodyEmpty:true,children:}},{_id:5b715f400b125a00032a990a,category:5b6d89a09d346300038baf55,createdAt:2018-08-13T10:36:48.584Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:viber-business-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5b715f516a90fc00037b4d43,category:5b6d89a09d346300038baf55,parentDoc:5b715f400b125a00032a990a,createdAt:2018-08-13T10:37:05.086Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n }\n,name:OK}},apiSetting:5d8ac09de7b73f03363d49cc,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:viber-business-contacts-list,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5b715f6c6a90fc00037b4d44,category:5b6d89a09d346300038baf55,parentDoc:5b715f400b125a00032a990a,createdAt:2018-08-13T10:37:32.033Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d8ac09de7b73f03363d49cc,results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \name\: \15558576309\,\n \phone_number\: \15558576309\\n},name:OK}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a0aa45d2aad4d001ad60cd0,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:viber-business-contacts-get,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5b715f73a373290003f803ca,category:5b6d89a09d346300038baf55,parentDoc:5b715f400b125a00032a990a,createdAt:2018-08-13T10:37:39.699Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code: ,language:json,status:204,name:No Content}},examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},apiSetting:5d8ac09de7b73f03363d49cc,auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:viber-business-contacts-delete,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5b7162260b125a00032a9959,category:5b6d89a09d346300038baf55,createdAt:2018-08-13T10:49:10.881Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:viber-business-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5b7162346a90fc00037b4d95,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:24.735Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:viber-business-webhooks-message-received,type:basic,title:Message Received,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5b71623d6711770003dbce94,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:33.869Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:viber-business-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5b71624a6711770003dbce96,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:46.541Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:viber-business-webhooks-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:5b7162446711770003dbce95,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:40.303Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:59fc42803cf718001069b934,settings:,results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:viber-business-webhooks-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:5b7162520b125a00032a995a,category:5b6d89a09d346300038baf55,parentDoc:5b7162260b125a00032a9959,createdAt:2018-08-13T10:49:54.472Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{language:json,code:{},name:,status:200},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:viber-business-webhooks-message-echo,type:basic,title:Message Echo,isBodyEmpty:false,children:}}},{_id:5d9330eb95026a001227fbf4,project:584bd29609104d23007d9ec9,version:59fc42803cf718001069b9ab,isAPI:false,reference:true,createdAt:2019-10-01T10:56:43.295Z,order:11,slug:whatsapp-1,title:WhatsApp,__v:0,pages:{_id:5d933189bc1938002815a6df,createdAt:2019-10-01T10:59:21.759Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:api-whatsapp,type:basic,title:WhatsApp,parentDoc:null,isBodyEmpty:false,children:},{_id:5d9331ec158aea0041576002,createdAt:2019-10-01T11:01:00.705Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{code:{},name:,status:200,language:json},{name:,status:400,language:json,code:{}}},auth:required,params:,url:,method:get},isReference:true,order:1,slug:whatsapp-messages,type:basic,title:Messages,parentDoc:null,isBodyEmpty:false,children:{_id:5d9da9b8020606005e46c795,createdAt:2019-10-09T09:34:48.954Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:whatsapp-messages-handling-errors,type:basic,title:Handling Message Errors,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5d93324768618100fd3d4a4d,createdAt:2019-10-01T11:02:31.913Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,code:\n {\n \id\: \6456078996108088196\,\n \direction\: \sent\,\n \sent\: \2018-02-06T19:15:38.860Z\,\n \delivered\: null,\n \read\: null,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \payload\: \text\,\n \type\: \Hello world!\\n }\n }\n,language:json,status:200}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339/messages}},apiSetting:5d933029747232001ae76e83,auth:required,params:{_id:5a7071e1b3c9580024d1a2f5,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:5a7071e1b3c9580024d1a2f4,ref:,in:path,required:false,desc:Id of the contact.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id}/messages,method:get},isReference:true,order:1,slug:whatsapp-messages-messages,type:endpoint,title:List Messages,isBodyEmpty:false,children:},{_id:5d9332c32e9e10002fe5b2cd,createdAt:2019-10-01T11:04:35.391Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{settings:,examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n}}},results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Hello world!\\n }\n},name:null}},apiSetting:5d933029747232001ae76e83,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:586d2081a63f5d2500c86b83,ref:,in:body,required:true,desc:Phone number of the contact.,default:,type:string,name:contact.phone_number},{_id:586d20b39a854123001acd78,ref:,in:body,required:true,desc:Must be set to `text`.,default:,type:string,name:content.type},{_id:586d20b39a854123001acd77,ref:,in:body,required:true,desc:Text to be sent. Maximum size of 4096 characters. The text can be formatted(ref:whatsapp-messages-text-formatting).,default:,type:string,name:content.payload},url:/v1/messages,method:post},isReference:true,order:2,slug:whatsapp-messages-text,type:endpoint,title:Text,isBodyEmpty:false,children:},{_id:5d933d39158aea00415760e4,createdAt:2019-10-01T11:49:13.331Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:whatsapp-messages-text-formatting,type:basic,title:Formatting in Text Messages,isBodyEmpty:false,children:},{_id:5db330c00bcbdb003652d13a,createdAt:2019-10-25T17:28:32.898Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5db32d82109f9600329bdad4,settings:,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json,status:201}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \image\,\n \payload\: {\n \url\: \https://upload.wikimedia.org/wikipedia/commons/1/11/V%C3%A1clav_Havel_cut_out.jpg\\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `image`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the image to be sent.,default:,type:string,name:content.payload.url},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:4,slug:whatsapp-messages-image,type:endpoint,title:Image,isBodyEmpty:false,children:},{_id:5e342065d3a47601de5e8475,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,createdAt:2020-01-31T00:52:49.133Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \audio\,\n \payload\: {\n \url\: \https://amio-testing.s3.eu-central-1.amazonaws.com/amio-communicator/audio.mp3\\n }\n }\n},language:json}},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \audio\,\n \payload\: {\n \url\: \https://amio-testing.s3.eu-central-1.amazonaws.com/amio-communicator/audio.mp3\\n }\n }\n},language:json,status:201}},settings:,apiSetting:5db32dff3ad555003555560c,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `audio`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the audio to be sent.,default:,type:string,name:content.payload.url},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:5,slug:whatsapp-messages-audio,type:endpoint,title:Audio,isBodyEmpty:false,children:},{_id:5e3424817dd55f01f93e17db,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,createdAt:2020-01-31T01:09:23.862Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5db32dc5452066001d83c181,settings:,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\\n }\n }\n},language:json,status:201}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \file\,\n \payload\: {\n \url\: \https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `file`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the file to be sent.,default:,type:string,name:content.payload.url},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:6,slug:whatsapp-messages-file,type:endpoint,title:File,isBodyEmpty:false,children:},{_id:5e3427de7dd55f01f93e17fc,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,createdAt:2020-01-31T01:09:23.862Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://techslides.com/demos/sample-videos/small.mp4\\n }\n }\n},language:json}},results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \video\,\n \payload\: {\n \url\: \http://techslides.com/demos/sample-videos/small.mp4\\n }\n }\n},language:json,status:201}},settings:,apiSetting:5e3425a097e32d020fa788b5,auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `video`.,default:,type:string,name:content.type},{_id:585a7b3e7904db2d009b5977,ref:,in:body,required:true,desc:Url of the video to be sent.,default:,type:string,name:content.payload.url},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:7,slug:whatsapp-messages-video,type:endpoint,title:Video,isBodyEmpty:false,children:},{_id:5e57d130391ffb002c16a762,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,createdAt:2020-02-27T14:11:55.497Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5e57cf5e9c7e970072b7dcf4,settings:,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \location\,\n \payload\: {\n \address\: \Great Russell St, Bloomsbury, London WC1B 3DG, United Kingdom\,\n \latitude\: 51.519421,\n \name\: \The British Museum\,\n \longitude\: -0.126946\n }\n }\n},language:json,status:201}},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \location\,\n \payload\: {\n \name\: \The British Museum\,\n \address\: \Great Russell St, Bloomsbury, London WC1B 3DG, United Kingdom\,\n \latitude\: 51.519421,\n \longitude\: -0.126946\n }\n }\n},language:json}},auth:required,params:{_id:58541391e97784190069b9de,ref:,in:body,required:true,desc:Id of the channel you wish to send the message to.,default:,type:string,name:channel.id},{_id:5854206ce6afe623008aa9b8,ref:,in:body,required:true,desc:Id of the contact. Id is unique across channels and is generated by Amio.,default:,type:string,name:contact.id},{_id:585a7b977904db2d009b5983,ref:,in:body,required:true,desc:Must be set to `location`.,default:,type:string,name:content.type},{_id:5e57d130391ffb002c16a766,ref:,in:body,required:false,desc:Location name or title.,default:,type:string,name:content.payload.name},{_id:5e57d130391ffb002c16a765,ref:,in:body,required:false,desc:Location address.,default:,type:string,name:content.payload.address},{_id:5e57d130391ffb002c16a764,ref:,in:body,required:true,desc:Location latitude.,default:,type:string,name:content.payload.latitude},{_id:5e57d130391ffb002c16a763,ref:,in:body,required:true,desc:Location longitude,default:,type:string,name:content.payload.longitude},{_id:5a16a3c028bd9b0012b3da1f,ref:,in:body,required:false,desc:Metadata(ref:facebook-messenger-messages-metadata) allows you to send any arbitrary data with the message. They are delivered back with Message Echo(ref:facebook-messeger-webhooks-message-echo) webhook.,default:,type:object,name:metadata},url:/v1/messages,method:post},isReference:true,order:8,slug:whatsapp-messages-location,type:endpoint,title:Location,isBodyEmpty:false,children:},{_id:60cc8ee1e70ec00335b8f54a,api:{method:post,url:/v1/messages,auth:required,results:{codes:{name:,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \text\:\🚚📦 Your Order #12374 has been shipped\,\n \buttons\: \n {\n \type\:\postback\,\n \title\: \Track Package\,\n \payload\: \button_payload1\\n },\n {\n \type\:\postback\,\n \title\: \Get Receipt\,\n \payload\: \button_payload2\\n },\n {\n \type\:\postback\,\n \title\: \Change Address\,\n \payload\: \button_payload3\\n }\n \n }\n }\n},language:json,status:201}},params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:60cca2cdbb976f0052f91c15},{name:contact.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:60cca2cdbb976f0052f91c14},{name:content.type,type:string,enumValues:,default:,desc:Must be set to `structure`.,required:true,in:body,ref:,_id:60cca2cdbb976f0052f91c13},{name:content.payload.text,type:string,enumValues:,default:,desc:Message text. Max **1024 characters**.,required:true,in:body,ref:,_id:60cca2cdbb976f0052f91c12},{name:content.payload.buttons,type:array_object,enumValues:,default:,desc:Buttons to be shown in the message menu. Maximum number of buttons is 10.,required:false,in:body,ref:,_id:60cca2cdbb976f0052f91c11},{name:content.payload.buttons.type,type:string,enumValues:,default:,desc:Type of the button. Only `postback` is supported.,required:false,in:body,ref:,_id:60cca2cdbb976f0052f91c10},{name:content.payload.buttons.title,type:string,enumValues:,default:,desc:Title of the button. Maximum length is 20 characters.,required:false,in:body,ref:,_id:60cca2cdbb976f0052f91c0f},{name:content.payload.buttons.payload,type:string,enumValues:,default:,desc:Any arbitrary data. When user presses the button, you will receive this data as part of Postback Received(#whatsapp-webhooks-postback-received) webhook. Maximum length is 1000 characters.,required:false,in:body,ref:,_id:60cca2cdbb976f0052f91c0e},examples:{codes:{code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \id\: \6456078781510718339\\n },\n \content\: {\n \type\: \structure\,\n \payload\: {\n \text\:\🚚📦 Your Order #12374 has been shipped\,\n \buttons\: \n {\n \type\:\postback\,\n \title\: \Track Package\,\n \payload\: \button_payload1\\n },\n {\n \type\:\postback\,\n \title\: \Get Receipt\,\n \payload\: \button_payload2\\n },\n {\n \type\:\postback\,\n \title\: \Change Address\,\n \payload\: \button_payload3\\n }\n \n }\n }\n},language:json}},apiSetting:60cc8f6f14124402d889f542},title:Structure,type:endpoint,slug:whatsapp-messages-structure,order:9,isReference:true,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:structure,createdAt:2021-06-18T12:17:37.144Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,isBodyEmpty:false,children:},{_id:60ed5a8bb8ba68005673318f,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Quick Replies,type:basic,slug:whatsapp-messages-quick-replies,order:10,isReference:true,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:quick-replies,createdAt:2021-07-13T09:19:07.351Z,parentDoc:5d9331ec158aea0041576002,category:5d9330eb95026a001227fbf4,isBodyEmpty:false,children:}},{_id:5dce99c55b0983002636fc2e,createdAt:2019-11-15T12:27:49.151Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:2,slug:whatsapp-templates,type:basic,title:Templates,parentDoc:null,isBodyEmpty:false,children:{_id:5dcea7257a2bb900188a3f9b,createdAt:2019-11-15T13:24:53.089Z,parentDoc:5dce99c55b0983002636fc2e,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:0,slug:whatsapp-sending-templates,type:basic,title:Sending Templates,isBodyEmpty:false,children:},{_id:5dcea138118e08002eab7a45,createdAt:2019-11-15T12:59:36.800Z,parentDoc:5dce99c55b0983002636fc2e,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5dce9fdc841080003e5bb4f6,results:{codes:{status:201,language:json,code:{\n \id\: \6456078996108088196\,\n \channel\: {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\\n },\n \contact\: {\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\\n },\n \content\: {\n \type\: \text\,\n \payload\: \Welcome to Amio, Albert! We are ready to help you succeed with messaging. 🚀\\n }\n},name:null}},examples:{codes:{language:json,code:{\n \channel\: {\n \id\: \6456078759331238786\\n },\n \contact\: {\n \phone_number\: \+1-555-857-6309\\n },\n \message_template\: {\n \id\: \4726078759445238153\,\n \substitution\: {\n \localizations\: {\n \default\: {\n \name\: \Albert\\n }\n }\n }\n }\n}}},settings:,auth:required,params:{name:channel.id,type:string,enumValues:,default:,desc:Id of the channel you wish to send the message to.,required:true,in:body,ref:,_id:58541391e97784190069b9de},{name:contact.phone_number,type:string,enumValues:,default:,desc:Phone number of the contact.,required:true,in:body,ref:,_id:586d2081a63f5d2500c86b83},{name:message_template.id,type:string,enumValues:,default:,desc:ID of a template that will be used. At the moment, ask us for the ID at support@amio.io .,required:true,in:body,ref:,_id:586d20b39a854123001acd78},{name:message_template.substitution,type:object,enumValues:,default:,desc:Substitution hold localized substitutions that will be used to replace placeholders in the template.,required:true,in:body,ref:,_id:586d20b39a854123001acd77},{name:message_template.localizations,type:object,enumValues:,default:,desc:Keys are locales(https://docs.amio.io/v1.0/reference#locale) and `default`. Currently we support only `default` which must always be provided.,required:true,in:body,ref:,_id:5dcea43041c9ab05e875dbce},{name:message_template.substitution.localizations. {{locale_or_default}},type:object,enumValues:,default:,desc:Keys are placeholders from the template with their values that will be replaced in the template.,required:true,in:body,ref:,_id:5dcea43041c9ab05e875dbcd},url:/v1/messages,method:post},isReference:true,order:1,slug:whatsapp-templates-text,type:endpoint,title:Text,deprecated:false,icon:,previousSlug:,isBodyEmpty:false,children:}},{_id:5dd67ed931e918096878ce59,createdAt:2019-11-21T12:11:05.553Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:3,slug:whatsapp-channels,type:basic,title:Channels,parentDoc:null,isBodyEmpty:false,children:{_id:5dd683fe988ad608fac5812f,createdAt:2019-11-21T12:33:02.336Z,parentDoc:5dd67ed931e918096878ce59,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d933029747232001ae76e83,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078759331238786\,\n \type\: \whatsapp\,\n \name\: \WhatsApp - IT Crowd\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \whatsapp_business_account\: {\n \phone_number\: \01189998819991197253\,\n }\n }\n,name:OK}},examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels,name:cUrl}},auth:required,params:,url:/v1/channels,method:get},isReference:true,order:0,slug:whatsapp-channels-list-channels,type:endpoint,title:List Channels,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5dd687d99d66f509ffdf1773,createdAt:2019-11-21T12:49:29.454Z,parentDoc:5dd67ed931e918096878ce59,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786,name:cUrl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \whatsapp\,\n \name\: \WhatsApp - IT Crowd\,\n \mode\: \production\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \whatsapp_business_account\: {\n \phone_number\: \01189998819991197253\,\n }\n},name:OK}},apiSetting:5d933029747232001ae76e83,auth:required,params:,url:/v1/channels/{channel_id},method:get},isReference:true,order:1,slug:whatsapp-channels-get-channel,type:endpoint,title:Get Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:},{_id:5e1725600c209503d87a005a,parentDoc:5dd67ed931e918096878ce59,category:5d9330eb95026a001227fbf4,createdAt:2020-01-09T05:32:28.559Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d933029747232001ae76e83,results:{codes:{status:201,language:json,code:{\n \id\: \6456078759331238786\,\n \type\: \whatsapp\,\n \name\: \Your WA Business Account\,\n \mode\: \sandbox\,\n \webhook\: {\n \id\: \6456079006639985542\,\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\,\n \ssl_verification\: true\n },\n \whatsapp_business_account\: {\n \t\phone_number\: \+11 123 456 789\\n }\n},name:OK}},examples:{codes:{language:json,code:{\n \type\: \whatsapp\,\n \name\: \Your WA Business Account\,\n \mode\: \sandbox\,\n \webhook\: {\n \url\: \https://my-project.com/webhooks\,\n \secret\: \6OUlfYyRZ393ZEoSncNAZfoCN0WveK\\n },\n \whatsapp_business_account\: {\n \t\phone_number\: \+11 123 456 789\\n }\n}\n }},auth:required,params:{name:type,type:string,enumValues:,default:,desc:Channel type, `whatsapp`.,required:true,in:body,ref:,_id:5a1c4077f512d400124699bb},{name:name,type:string,enumValues:,default:,desc:Name of the channel. If not set, it will be generated automatically.,required:false,in:body,ref:,_id:5a1c459dacac6b001e666b52},{name:mode,type:string,enumValues:,default:,desc:Mode(ref:section-channel-modes) of the channel. `production` - Send Message(ref:viber-business-messages-text) requests will be accepted and sent through Viber network. `sandbox ` - Send Message(ref:viber-business-messages-text) requests will be sent using common Amio Sender ID. Messages sent are not charged but number of messages sent is limited. `test` - Send Message(ref:viber-business-messages-text) requests will be accepted but wont be processed any further. This avoids the cost of sending the message through Viber.,required:false,in:body,ref:,_id:5d5d13404670d90037f7e92e},{name:webhook.url,type:string,enumValues:,default:,desc:Webhook url where all channel events would be sent to.,required:false,in:body,ref:,_id:5a1c40a1c73b44001ed59949},{name:whatsapp_business_account.phone_number,type:string,enumValues:,default:,desc:The phone number that your customers will use to reach your WhatsApp Business Account.,required:true,in:body,ref:,_id:5a1d322f61bdc2003611d6b5},{name:webhook.secret,type:string,enumValues:,default:,desc:Secret token for securing received webhook calls. See Webhook Security(ref:security) for more details. \u003cbr /> The minimum length is 20 characters. \u003cbr />If not provided, the token will be generated.,required:false,in:body,ref:,_id:5e3c0834938acf002595c031},url:/v1/channels,method:post},isReference:true,order:2,slug:whatsapp-channels-create-channel,type:endpoint,title:Create Channel,deprecated:false,icon:,mdx:{},previousSlug:,isBodyEmpty:false,children:}},{_id:5e46b7347e7c320031110b03,category:5d9330eb95026a001227fbf4,createdAt:2020-02-14T15:03:03.632Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:4,slug:whatsapp-contacts,type:basic,title:Contacts,parentDoc:null,isBodyEmpty:false,children:{_id:5e46b87a6d0858007275e9c5,parentDoc:5e46b7347e7c320031110b03,category:5d9330eb95026a001227fbf4,createdAt:2020-02-13T23:52:45.030Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d933029747232001ae76e83,results:{codes:{status:200,language:json,code:\n {\n \id\: \6456078781510718339\,\n \name\: \Steve\,\n \platform_id\: \15558576309\,\n \phone_number\: \1555857309\\n }\n,name:OK}},examples:{codes:{name:cUrl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts,language:curl}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},url:/v1/channels/{channel_id}/contacts,method:get},isReference:true,order:0,slug:whatsapp-contacts-list,type:endpoint,title:List Contacts,isBodyEmpty:false,children:},{_id:5e46b8f7e86f960011ba52a2,parentDoc:5e46b7347e7c320031110b03,category:5d9330eb95026a001227fbf4,createdAt:2020-02-13T23:52:44.192Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{examples:{codes:{language:curl,code:curl --request GET \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,name:cUrl}},results:{codes:{status:200,language:json,code:{\n \id\: \6456078781510718339\,\n \phone_number\: \15558576309\,\n \platform_id\: \15558576309\,\n \name\: \Steve\\n},name:OK}},apiSetting:5d933029747232001ae76e83,auth:required,params:{name:channel_id,type:string,default:,desc:Id of the channel.,required:false,in:path,ref:,_id:58d26787eb28591900333600},{name:contact_id,type:string,default:,desc:Id of the contact.,required:false,in:path,ref:,_id:5a0aa45d2aad4d001ad60cd0},url:/v1/channels/{channel_id}/contacts/{contact_id},method:get},isReference:true,order:1,slug:whatsapp-contacts-get,type:endpoint,title:Get Contact,isBodyEmpty:false,children:},{_id:5e46b91fbf875d00582642ef,parentDoc:5e46b7347e7c320031110b03,category:5d9330eb95026a001227fbf4,createdAt:2020-02-14T15:12:52.621Z,link_external:false,link_url:,sync_unique:,hidden:false,api:{apiSetting:5d933029747232001ae76e83,examples:{codes:{code:curl --request DELETE \\\n --url https://api.amio.io/v1/channels/6456078759331238786/contacts/6456078781510718339,language:curl}},results:{codes:{code: ,language:json,status:204,name:No Content}},auth:required,params:{_id:58d26787eb28591900333600,ref:,in:path,required:false,desc:Id of the channel.,default:,type:string,name:channel_id},{_id:59f325505f12d6001ab8ed94,ref:,in:path,required:false,desc:Id of the contact to be deleted.,default:,type:string,name:contact_id},url:/v1/channels/{channel_id}/contacts/{contact_id},method:delete},isReference:true,order:2,slug:whatsapp-contacts-delete,type:endpoint,title:Delete Contact,isBodyEmpty:true,children:}},{_id:5d95b43da0150a00249740c1,createdAt:2019-10-03T08:41:33.758Z,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{status:400,language:json,code:{},name:}},auth:required,params:,url:,method:get},isReference:true,order:5,slug:whatsapp-webhooks,type:basic,title:Webhooks,parentDoc:null,isBodyEmpty:false,children:{_id:5d95b415c1d7cf005cf10798,createdAt:2019-10-03T08:40:53.899Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{name:,status:200,language:json,code:{}},{language:json,code:{},name:,status:400}},auth:required,params:,url:,method:get,examples:{codes:}},isReference:true,order:0,slug:whatsapp-webhooks-message-received,type:basic,title:Message Received,previousSlug:,deprecated:false,icon:,mdx:{},isBodyEmpty:false,children:},{_id:5def96c21038430018a137f0,createdAt:2019-12-10T12:59:46.876Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:1,slug:whatsapp-webhooks-messages-delivered,type:basic,title:Messages Delivered,isBodyEmpty:false,children:},{_id:5def970a341bb90057635380,createdAt:2019-12-10T13:00:58.616Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:2,slug:whatsapp-webhooks-messages-read,type:basic,title:Messages Read,isBodyEmpty:false,children:},{_id:5d9d9cce266531004a6bcbfd,createdAt:2019-10-09T08:39:42.078Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,link_external:false,link_url:,sync_unique:,hidden:false,api:{results:{codes:{status:200,language:json,code:{},name:},{status:400,language:json,code:{},name:}},settings:,apiSetting:59fc42803cf718001069b934,auth:required,params:,url:,method:get},isReference:true,order:3,slug:whatsapp-webhooks-message-failed,type:basic,title:Message Failed,isBodyEmpty:false,children:},{_id:60cca4ba9176d3002cb3d83a,api:{method:get,url:,auth:required,results:{codes:{name:,code:{},language:json,status:200},{name:,code:{},language:json,status:400}},params:},title:Postback Received,type:basic,slug:whatsapp-webhooks-postback-received,order:4,isReference:true,hidden:false,sync_unique:,link_url:,link_external:false,previousSlug:postback-received,createdAt:2021-06-18T13:50:50.009Z,parentDoc:5d95b43da0150a00249740c1,category:5d9330eb95026a001227fbf4,isBodyEmpty:false,children:}}},meta:{title:Amio,type:home},aiConfig:{enabled:false,settings:{errors:null,styleguide:null,warnings:null}},config:{algoliaIndex:readme_search_v2,amplitude:{apiKey:dc8065a65ef83d6ad23e37aaf014fc84,enabled:true},api:{upload:{fileSizeLimit:10485760,fileSizeLimitFormatted:10MB}},asset_url:https://cdn.readme.io,dashDomain:dash.readme.com,domain:readme.io,domainFull:https://dash.readme.com,encryptedLocalStorageKey:ekfls-2025-03-27,fullstory:{enabled:true,orgId:FSV9A},git:{sync:{bitbucket:{installationLink:https://developer.atlassian.com/console/install/310151e6-ca1a-4a44-9af6-1b523fea0561?signatureAYABeMn9vqFkrg%2F1DrJAQxSyVf4AAAADAAdhd3Mta21zAEthcm46YXdzOmttczp1cy13ZXN0LTI6NzA5NTg3ODM1MjQzOmtleS83MDVlZDY3MC1mNTdjLTQxYjUtOWY5Yi1lM2YyZGNjMTQ2ZTcAuAECAQB4IOp8r3eKNYw8z2v%2FEq3%2FfvrZguoGsXpNSaDveR%2FF%2Fo0BHUxIjSWx71zNK2RycuMYSgAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDOJgARbqndU9YM%2FRdQIBEIA7unpCah%2BIu53NA72LkkCDhNHOv%2BgRD7agXAO3jXqw0%2FAcBOB0%2F5LmpzB5f6B1HpkmsAN2i2SbsFL30nkAB2F3cy1rbXMAS2Fybjphd3M6a21zOmV1LXdlc3QtMTo3MDk1ODc4MzUyNDM6a2V5LzQ2MzBjZTZiLTAwYzMtNGRlMi04NzdiLTYyN2UyMDYwZTVjYwC4AQICAHijmwVTMt6Oj3F%2B0%2B0cVrojrS8yZ9ktpdfDxqPMSIkvHAGT%2FMTvCxC3XwnwlulZe975AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMMUUe9d1YmFOo373TAgEQgDuJo7TayM6NL19Sj9RPooRrl8rYxwKgvu9gkLNc3GuyyovWI1xA2qTr0LQzMRsf3imrAWsywzPcsjnvuAAHYXdzLWttcwBLYXJuOmF3czprbXM6dXMtZWFzdC0xOjcwOTU4NzgzNTI0MzprZXkvNmMxMjBiYTAtNGNkNS00OTg1LWI4MmUtNDBhMDQ5NTJjYzU3ALgBAgIAeLKa7Dfn9BgbXaQmJGrkKztjV4vrreTkqr7wGwhqIYs5AZR28Sibv2eBxSIg2MydtvEAAAB%2BMHwGCSqGSIb3DQEHBqBvMG0CAQAwaAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzzWhThsIgJwrr%2FY2ECARCAOxoaW9pob21lweyAfrIm6Fw7gd8D%2B%2F8LHk4rl3jjULDM35%2FVPuqBrqKunYZSVCCGNGB3RqpQJr%2FasASiAgAAAAAMAAAQAAAAAAAAAAAAAAAAAEokowLKsF1tMABEq%2BKNyJP%2F%2F%2F%2F%2FAAAAAQAAAAAAAAAAAAAAAQAAADJLzRcp6MkqKR43PUjOiRxxbxXYhLc6vFXEutK3%2BQ71yuPq4dC8pAHruOVQpvVcUSe8dptV8c7wR8BTJjv%2F%2FNe8r0g%3D&productbitbucket}}},metrics:{billingCronEnabled:true,dashUrl:https://m.readme.io,defaultUrl:https://m.readme.io,exportMaxRetries:12,wsUrl:wss://m.readme.io},micro:{baseUrl:https://micro-beta.readme.com},proxyUrl:https://try.readme.io,readmeRecaptchaSiteKey:6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x,releaseVersion:5.612.0,reservedWords:{tools:execute-request,get-code-snippet,get-endpoint,get-request-body,get-response-schema,get-server-variables,list-endpoints,list-security-schemes,list-specs,search-specs,search,fetch},sentry:{dsn:https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166,enabled:true},shMigration:{promoVideo:,forceWaitlist:false,migrationPreview:false},sslBaseDomain:readmessl.com,sslGenerationService:ssl.readmessl.com,stripePk:pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a,superHub:{newProjectsEnabled:true},wootric:{accountToken:NPS-122b75a4,enabled:true}},context:{labs:{},user:{isAuthenticated:false},terms:,variables:{user:{},defaults:{source:,_id:5afa9d9f9c0cc30003a0b3ff,name:variable,default:someAwe,type:},{source:security,_id:642bf521f7880d0abe693d70,name:Authorization,type:apiKey,default:API Token,apiSetting:5dc53a440d5f2d004363aee0}},project:{_id:584bd29609104d23007d9ec9,accessRules:{branch_merge:{admin:true,editor:false},branch_approve:{admin:true,editor:false}},ai:{chat:{knowledge:{custom_knowledge:null,use_project_knowledge:false},models:}},appearance:{html_footer:,javascript:,nextStepsLabel:,showVersion:false,theme:solid,html_body:,logo_white_use:true,hideTableOfContents:false,hide_logo:false,link_logo_to_url:true,overlay:grain,header:{img:https://files.readme.io/db60208-docbg.jpg,docbg.jpg,1920,320,#7c62ef,img_pos:cc,img_size:cover,style:gradient,linkStyle:buttons},html_footer_meta:,javascript_hub2:,colors:{header_text:,highlight:,main:#664ac5,main_alt:#5f4df7,body_highlight:#7238ff,custom_login_link_color:},sticky:false,stylesheet:,categoriesAsDropdown:false,logo_white:https://files.readme.io/2f818fb-white-logo.png,white-logo.png,150,52,#333,notheme:false,typography:{headline:Open+Sans:400:sans-serif,tk_body:,tk_headline:,tk_key:,typekit:false,body:Open+Sans:400:sans-serif},favicon:https://files.readme.io/dc20ed1-small-favicon-32x32.png,favicon-32x32.png,32,32,#6c44fc,https://files.readme.io/285b548-favicon-32x32.png,html_head:,html_promo:,logo:https://files.readme.io/d30580e-small-doclogo.png,doclogo.png,150,52,#6c2cfc,https://files.readme.io/c6799cb-doclogo.png,main_body:{type:links},stylesheet_hub2:.content-body .magic-block-textarea ul li, .content-body .magic-block-api-header ul li, .content-body .magic-block-textarea ol li, .content-body .magic-block-api-header ol li {\n margin-bottom: 0.15em;\n},body:{style:none},html_hidelinks:false,landing:false,promos:{extras:{type:buttons,buttonPrimary:get-started,buttonSecondary:},title:Amio Developer Hub,text:Welcome to Amio! Lets build on top of most reliable and full feature set API for messaging.,_id:584bd29609104d23007d9eca},referenceLayout:row,childrenAsPills:false,global_landing_page:{html:,redirect:},splitReferenceDocs:false,subheaderStyle:dropdown,rdmd:{callouts:{useIconFont:false},theme:{background:,border:,markdownEdge:,markdownFont:,markdownFontSize:,markdownLineHeight:null,markdownRadius:,markdownText:,markdownTitle:,markdownTitleFont:,mdCodeBackground:,mdCodeFont:,mdCodeRadius:,mdCodeTabs:,mdCodeText:,tableEdges:,tableHead:,tableHeadText:,tableRow:,tableStripe:,tableText:,text:,title:}},showMetricsInReference:true,referenceSimpleMode:true,stylesheet_hub3:/* Redesign Updates 4/15/2022 (ERDMAN) */\n\n.useReactApp div h3 a .pull-right {\n color: #bbb;\n font-weight: 400;\n font-size: 12px;\n text-transform: uppercase;\n padding-top: 6px;\n}\n .useReactApp .field-description strong {\n font-weight: 700;\n padding: 10px;\n font-size: 20px;\n}\n .useReactApp .col-sm-4 {\n -ms-flex-preferred-size: 100%;\n flex-basis: 100%;\n max-width: 100%;\n padding:10px !important;\n}\n @media only screen and (min-width: 48em){\n .useReactApp .col-sm-4 {\n -ms-flex-preferred-size: 33.33333333%;\n flex-basis: 33.33333333%;\n max-width: 33.33333333%;\n padding:20px !important;\n }\n .useReactApp .row.hub-landing-links.left {\n display: flex;\n }\n}\n .useReactApp .rm-Logo-img {\n width: 116px;\n height: 40px;\n},loginLogo:,logo_large:false,colorScheme:light,changelog:{layoutExpanded:false,showAuthor:true,showExactDate:false},allowApiExplorerJsonEditor:false,ai_dropdown:enabled,ai_options:{chatgpt:enabled,claude:enabled,clipboard:enabled,view_as_markdown:enabled,copilot:enabled,ask_ai:disabled},showPageIcons:true,layout:{full_width:false,style:classic},methodBadgeStyle:classic,showMethodInSidebar:true,showBreadcrumbs:false},custom_domain:docs.amio.io,childrenProjects:,derivedPlan:startup,description:Amio REST API reference documentation. The API allows you to send messages to users on various messaging platforms as well as receive them back via webhooks invocations. Amio REST API follows proven design principle to make it really easy for you to start with messaging today.,isExternalSnippetActive:false,error404:,experiments:,first_page:landing,flags:{allowImport:false,autoSslGeneration:true,enterprise:false,migrationRun:false,oauth:false,allowXFrame:false,allow_hub2:false,correctnewlines:false,migrationSwaggerRun:true,stripe:false,hub2:true,jwt:false,speedyRender:false,hideGoogleAnalytics:false,swagger:false,newApiExplorer:true,alwaysShowDocPublishStatus:false,cookieAuthentication:false,directGoogleToStableVersion:false,disableAnonForum:false,newEditor:true,newMarkdown:false,newMarkdownBetaProgram:true,newMarkdownLooseMode:false,translation:false,oldMarkdown:false,newSearch:true,rdmdCompatibilityMode:false,tutorials:true,allowApiExplorerJsonEditor:false,staging:false,useReactApp:true,newHeader:false,referenceRedesign:false,auth0Oauth:false,graphql:false,singleProjectEnterprise:false,dashReact:false,allowReferenceUpgrade:true,metricsV2:true,newEditorDash:true,enableRealtimeExperiences:false,reviewWorkflow:true,star:false,allowDarkMode:false,forceDarkMode:false,useReactGLP:false,disablePasswordlessLogin:false,personalizedDocs:false,myDevelopers:false,superHub:false,developerDashboard:false,allowReusableOTPs:false,dashHomeRefresh:false,owlbotAi:false,apiV2:false,git:{read:false,write:false},superHubBeta:false,dashQuickstart:false,disableAutoTranslate:false,customBlocks:false,devDashHub:false,disableSAMLScoping:false,allowUnsafeCustomHtmlSuggestionsFromNonAdmins:false,apiAccessRevoked:false,passwordlessLogin:default,disableSignups:false,billingRedesignEnabled:true,developerPortal:false,mdx:false,superHubDevelopment:false,annualBillingEnabled:true,devDashBillingRedesignEnabled:false,enableOidc:false,customComponents:false,disableDiscussionSpamRecaptchaBypass:false,developerViewUsersData:false,changelogRssAlwaysPublic:false,bidiSync:false,superHubMigrationSelfServeFlow:true,apiDesigner:false,hideEnforceSSO:false,localLLM:false,superHubManageVersions:false,gitSidebar:false,superHubGlobalCustomBlocks:false,childManagedBidi:false,superHubBranches:false,externalSdkSnippets:false,migrationPreview:false,requiresJQuery:false,superHubPreview:false,superHubBranchReviews:false,superHubMergePermissions:false,aiDocsAudit:false,aiPageLinting:false,disableAiChat:false,enableSuggestedEdits:false,githubCloudSync:false,superHubBranchMergeRules:false,superHubBranchReviewActions:false,bidiSyncGitlabSelfServe:true,gitTranslations:false,gitlabCloudSync:false,bidiSyncBitbucketSelfServe:false,superHubPlanManagement:false,mdxSanitizeComments:false,disableSuperframe:false,hideAiFeatures:false,mdxish:false,aiWriter:false,gittoUseNewIndexer:false,mdxishEditor:false,prefetch:false,bidiSyncUseOdbAlternates:false,superHubBranchReviewDashboard:false},fullBaseUrl:https://docs.amio.io/,git:{aiWriter:{setup:{error:{}}},sync:{installationRequest:{},connections:,providers:},renamedSlugs:},glossaryTerms:,graphqlSchema:,gracePeriod:{enabled:false,endsAt:null},shouldGateDash:false,healthCheck:{provider:,settings:{}},i18n:{defaultLanguage:en,languages:en,state:enabled},intercom_secure_emailonly:false,intercom:,is_active:true,integrations:{login:{}},internal:,jwtExpirationTime:0,landing_bottom:{type:html,alignment:left,html:\u003cdiv class\row hub-landing-links left\ style\padding: 30px\>\n \u003cdiv class\col-sm-4 col-xs-12\ style\padding: 0 20px\>\n \u003ch3 class\main_color\>\u003ca href\/docs\ ui-sref\docs\>\n \u003cdiv class\pull-right\>View All\u003c/div>\n \u003ci class\icon icon-documentation\>\u003c/i>\u003cstrong class\main_color\>Documentation\u003c/strong>\u003c/a>\u003c/h3>\n \u003cul class\links\>\n \u003cli style\text-align: center; padding: 10px 20px;\>\n Guides and comprehensive instructions which help you start with all types of messaging platforms in short time.\n \u003c/li>\n \u003c/ul>\n \u003c/div>\n \u003cdiv class\col-sm-4 col-xs-12\ style\padding: 0 20px\>\n \u003ch3 class\main_color\>\u003ca href\/reference\ ui-sref\reference\>\n \u003cdiv class\pull-right\>View All\u003c/div>\n \u003ci class\icon icon-reference\>\u003c/i>\u003cstrong class\main_color\>API Reference\u003c/strong>\u003c/a>\u003c/h3>\n \u003cul class\links\>\n \u003cli style\text-align: center; padding: 10px 20px;\>\n Complete REST API reference documentation with code examples and messenger screenshots.\n \u003c/li>\n \u003c/ul>\n \u003c/div>\n \u003cdiv class\col-sm-4 col-xs-12\ style\padding: 0 20px\>\n \u003ch3>\n \u003ca hrefmailto:support@amio.io>\n \u003cdiv class\pull-right\>Contact Us\u003c/div>\n \u003ci class\icon icon-support\>\u003c/i>\u003cstrong class\main_color\>Support\u003c/strong>\u003c/a>\u003c/h3>\n \u003cul class\links\>\n \u003cli style\text-align: center; padding: 10px 20px;\>\n We truly care about our customers. So if you cant find something in Amio documentation or you have any questions or comments, contact us on \u003ca hrefmailto:support@amio.io>support@amio.io\u003c/a>.\n \u003c/li>\n \u003c/ul>\n \u003c/div>\n\u003c/div>},mdxMigrationStatus:rdmd,metrics:{monthlyLimit:0,thumbsEnabled:false,planLimit:1000000,realtime:{dashEnabled:false,hubEnabled:false},monthlyPurchaseLimit:0,meteredBilling:{}},modules:{reference:true,examples:true,docs:true,landing:true,suggested_edits:true,discuss:false,changelog:false,logs:false,custompages:false,tutorials:false,graphql:false},name:Amio,nav_names:{discuss:,docs:Documentation,reference:API Reference,changelog:,tutorials:,recipes:},oauth_url:,onboardingCompleted:{documentation:true,appearance:true,jwt:true,api:true,logs:false,domain:true,metricsSDK:false},owlbot:{enabled:false,isPaying:false,customization:{answerLength:long,customTone:,defaultAnswer:,forbiddenWords:,tone:neutral},copilot:{enabled:false,hasBeenUsed:false,installedCustomPage:},exampleQuestions:{question1:,question2:,question3:},knowledge:,modelList:,newExperience:false,llmOptions:{model:{}}},owner:{id:584bd4c9bfa7ec23000e6a77,email:null,name:null},plan:startup,planOverride:,planSchedule:{stripeScheduleId:null,changeDate:null,nextPlan:null},planStatus:active,planTrial:startup,readmeScore:{components:{newDesign:{enabled:true,points:25},reference:{enabled:true,points:50},tryItNow:{enabled:true,points:35},syncingOAS:{enabled:false,points:10},customLogin:{enabled:true,points:25},metrics:{enabled:false,points:40},recipes:{enabled:false,points:15},pageVoting:{enabled:false,points:1},suggestedEdits:{enabled:true,points:10},support:{enabled:false,points:5},htmlLanding:{enabled:true,points:5},guides:{enabled:true,points:10},changelog:{enabled:false,points:5},glossary:{enabled:false,points:1},variables:{enabled:true,points:1},integrations:{enabled:true,points:2}},percentScore:37.5,totalScore:163},reCaptchaSiteKey:,reference:{alwaysUseDefaults:true,autoFillRequestExample:false,defaultExpandResponseExample:true,defaultExpandResponseSchema:false,enableOAuthFlows:false},seo:{overwrite_title_tag:false},stable:{_id:59fc42803cf718001069b9ab,project:584bd29609104d23007d9ec9,__v:52,forked_from:5914222af865370f000b39aa,createdAt:2016-12-10T10:01:58.690Z,releaseDate:2016-12-10T10:01:58.690Z,categories:584bd29609104d23007d9ecd,584bd774c4655b3900f8ab36,584bd78c09104d23007d9ed3,59fc42803cf718001069b924,59fc42803cf718001069b925,59fc42803cf718001069b926,59fc42803cf718001069b927,59fc42803cf718001069b928,585a70cfbe5b1c0f004f29a3,59fc42803cf718001069b929,59fc42803cf718001069b92a,59fc42803cf718001069b92b,5914222af865370f000b3955,59fc42803cf718001069b92c,59fc42803cf718001069b92d,59fc42803cf718001069b92e,59fc42803cf718001069b92f,59fc42803cf718001069b930,59fc42803cf718001069b931,59fc42803cf718001069b932,59fc42803cf718001069b933,5a3903d196654b002ae85841,5a39040d1ef072001e686f72,5a390442489d6a002683b1e1,5b290ac63187ed0003a39f79,5b6d89a09d346300038baf55,5bd9acb4608df7005518e47f,5c9b6d0ba42eb00024b4af2c,5c9b9f9ba1cc170039471288,5d273ddba3d7360243d48bab,5d2c76b7059ba7014799b44d,5d569fa6251176006d5c0d2b,5d5bf6b77913cf004e75718a,5d8abb9de6d3f900f7070309,5d8abbeb669e910036e59639,5d8abde8192ec60031349236,5d8abe2605260200d46221af,5d8abe6e24e071001806f5d4,5d8abeb7e83f7e0024e19045,5d8ac09de7b73f03363d49d0,5d8ac1aefc49f804578a0c29,5d8ac23b0c03c3002f58fc69,5d8ac5fa5478da001f7f3537,5d8e9953589ec60039e75d85,5d8e99f1ebdd2c006b877e2c,5d8e9a98c4c04c00696b57ce,5d8e9b7719f4740011d43b8d,5d8e9bc3f4e44300312dd1bb,5d8e9c39f4e44300312dd1cb,5d8e9cdeebdd2c006b877e54,5d8e9ea50f3b8a002575a34f,5d8e9f9ef9188300738106b9,5d8ea00cfb26fa001c90b791,5d8ea08fd89cd90046594b54,5d8ea140589ec60039e75ddd,5d8ea1e2255ef80065c71ab8,5d8ea25e31d0eb00385066e0,5d8ea29a4794a30018945b3a,5d933029747232001ae76e84,5d9330eb95026a001227fbf4,5d93554cc986080018662575,5db32d82109f9600329bdad6,5db32dc5452066001d83c183,5db32dff3ad555003555560e,5dc53a440d5f2d004363aee2,5dce9fdc841080003e5bb4f8,5e1322c3db64cf00124a906e,5e3425a097e32d020fa788b6,5e3437c6233acb01e8cb4e9e,5e426a35dd81f5001b88b670,5e426de8bedf32005fb53c29,5e4270a063f8090073f32bfc,5e57cf5e9c7e970072b7dcf5,60cc8f7014124402d889f543,6376bede127d990003169164,67c87f5f8987170010065a43,68c16049f45d950727146b92,is_deprecated:false,is_hidden:false,is_beta:false,is_stable:true,codename:MessageRead,version_clean:1.0.0,version:1.0,updatedAt:2025-09-10T11:26:01.346Z},subdomain:amio,subpath:,superHubWaitlist:false,topnav:{edited:true,left:,right:,bottom:},trial:{trialEndsAt:2016-12-24T10:01:58.656Z,trialDeadlineEnabled:true},translate:{languages:,provider:transifex,key_public:,org_name:,project_name:,show_widget:false},url:https://amio.io,versions:{_id:59fc42803cf718001069b9ab,project:584bd29609104d23007d9ec9,__v:52,forked_from:5914222af865370f000b39aa,createdAt:2016-12-10T10:01:58.690Z,releaseDate:2016-12-10T10:01:58.690Z,categories:584bd29609104d23007d9ecd,584bd774c4655b3900f8ab36,584bd78c09104d23007d9ed3,59fc42803cf718001069b924,59fc42803cf718001069b925,59fc42803cf718001069b926,59fc42803cf718001069b927,59fc42803cf718001069b928,585a70cfbe5b1c0f004f29a3,59fc42803cf718001069b929,59fc42803cf718001069b92a,59fc42803cf718001069b92b,5914222af865370f000b3955,59fc42803cf718001069b92c,59fc42803cf718001069b92d,59fc42803cf718001069b92e,59fc42803cf718001069b92f,59fc42803cf718001069b930,59fc42803cf718001069b931,59fc42803cf718001069b932,59fc42803cf718001069b933,5a3903d196654b002ae85841,5a39040d1ef072001e686f72,5a390442489d6a002683b1e1,5b290ac63187ed0003a39f79,5b6d89a09d346300038baf55,5bd9acb4608df7005518e47f,5c9b6d0ba42eb00024b4af2c,5c9b9f9ba1cc170039471288,5d273ddba3d7360243d48bab,5d2c76b7059ba7014799b44d,5d569fa6251176006d5c0d2b,5d5bf6b77913cf004e75718a,5d8abb9de6d3f900f7070309,5d8abbeb669e910036e59639,5d8abde8192ec60031349236,5d8abe2605260200d46221af,5d8abe6e24e071001806f5d4,5d8abeb7e83f7e0024e19045,5d8ac09de7b73f03363d49d0,5d8ac1aefc49f804578a0c29,5d8ac23b0c03c3002f58fc69,5d8ac5fa5478da001f7f3537,5d8e9953589ec60039e75d85,5d8e99f1ebdd2c006b877e2c,5d8e9a98c4c04c00696b57ce,5d8e9b7719f4740011d43b8d,5d8e9bc3f4e44300312dd1bb,5d8e9c39f4e44300312dd1cb,5d8e9cdeebdd2c006b877e54,5d8e9ea50f3b8a002575a34f,5d8e9f9ef9188300738106b9,5d8ea00cfb26fa001c90b791,5d8ea08fd89cd90046594b54,5d8ea140589ec60039e75ddd,5d8ea1e2255ef80065c71ab8,5d8ea25e31d0eb00385066e0,5d8ea29a4794a30018945b3a,5d933029747232001ae76e84,5d9330eb95026a001227fbf4,5d93554cc986080018662575,5db32d82109f9600329bdad6,5db32dc5452066001d83c183,5db32dff3ad555003555560e,5dc53a440d5f2d004363aee2,5dce9fdc841080003e5bb4f8,5e1322c3db64cf00124a906e,5e3425a097e32d020fa788b6,5e3437c6233acb01e8cb4e9e,5e426a35dd81f5001b88b670,5e426de8bedf32005fb53c29,5e4270a063f8090073f32bfc,5e57cf5e9c7e970072b7dcf5,60cc8f7014124402d889f543,6376bede127d990003169164,67c87f5f8987170010065a43,68c16049f45d950727146b92,is_deprecated:false,is_hidden:false,is_beta:false,is_stable:true,codename:MessageRead,version_clean:1.0.0,version:1.0,updatedAt:2025-09-10T11:26:01.346Z},variableDefaults:{source:,_id:5afa9d9f9c0cc30003a0b3ff,name:variable,default:someAwe,type:},{source:security,_id:642bf521f7880d0abe693d70,name:Authorization,type:apiKey,default:API Token,apiSetting:5dc53a440d5f2d004363aee0},webhookEnabled:false,isHubEditable:true},projectStore:{data:{allow_crawlers:disabled,canonical_url:null,default_version:{name:1.0},description:Amio REST API reference documentation. The API allows you to send messages to users on various messaging platforms as well as receive them back via webhooks invocations. Amio REST API follows proven design principle to make it really easy for you to start with messaging today.,git:{connection:{repository:null,organization:null,status:none}},glossary:,homepage_url:https://amio.io,id:584bd29609104d23007d9ec9,name:Amio,parent:null,redirects:,sitemap:disabled,llms_txt:disabled,subdomain:amio,suggested_edits:enabled,uri:/projects/me,variable_defaults:{name:variable,default:someAwe,source:,type:,id:5afa9d9f9c0cc30003a0b3ff},{name:Authorization,default:API Token,source:security,type:apiKey,id:642bf521f7880d0abe693d70},webhooks:,api_designer:{allow_editing:enabled},custom_login:{jwt_expiration_time:0,login_url:null,logout_url:null},features:{mdx:disabled},mcp:{custom_tools:,disabled_routes:,disabled_tools:},onboarding_completed:{api:true,appearance:true,documentation:true,domain:true,jwt:true,logs:false,metricsSDK:false},pages:{not_found:null,default_visibility:public},privacy:{openapi:admin,password:null,view:public},refactored:{status:disabled,migrated:unknown},seo:{overwrite_title_tag:disabled},metrics:{monthly_purchase_limit:0},feature_rules:{merge:{requirements:,allow_override:}},plan:{type:startup,grace_period:{enabled:false,end_date:null},trial:{expired:false,end_date:2016-12-24T10:01:58.656Z}},reference:{api_sdk_snippets:enabled,defaults:always_use,json_editor:disabled,method_badge_style:classic,oauth_flows:disabled,request_history:enabled,request_examples:collapsed,response_examples:expanded,response_schemas:collapsed,show_method_in_sidebar:enabled,sdk_snippets:{external:disabled}},ai:{owlbot:{enabled:false},chat:{models:,knowledge:{custom_knowledge:null,use_project_knowledge:false}}},health_check:{provider:none,settings:{manual:{status:down,url:null},statuspage:{id:null}}},integrations:{aws:{readme_webhook_login:{region:null,external_id:null,role_arn:null,usage_plan_id:null}},bing:{verify:null},google:{analytics:null,site_verification:null},heap:{id:null},koala:{key:null},localize:{key:null},postman:{key:null,client_id:null,client_secret:null,is_connected:false},recaptcha:{site_key:null,secret_key:null},segment:{key:null,domain:null},speakeasy:{key:null,spec_url:null},stainless:{key:null,name:null},typekit:{key:null},zendesk:{subdomain:null},intercom:{app_id:null,secure_mode:{key:null,email_only:false}}},permissions:{appearance:{private_label:disabled,custom_code:{css:enabled,html:disabled,js:disabled}},branches:{merge:{admin:true,editor:false},approve:{admin:true,editor:false}}},appearance:{brand:{primary_color:#664ac5,link_color:#7238ff,theme:light},changelog:{layout:collapsed,show_author:true,show_exact_date:false},layout:{full_width:disabled,style:classic},markdown:{callouts:{icon_font:emojis}},table_of_contents:enabled,whats_next_label:null,footer:{readme_logo:show},logo:{size:default,dark_mode:{uri:null,url:https://files.readme.io/2f818fb-white-logo.png,name:white-logo.png,width:150,height:52,color:#333,links:{original_url:null}},main:{uri:null,url:https://files.readme.io/d30580e-small-doclogo.png,name:doclogo.png,width:150,height:52,color:#6c2cfc,links:{original_url:https://files.readme.io/c6799cb-doclogo.png}},favicon:{uri:null,url:https://files.readme.io/dc20ed1-small-favicon-32x32.png,name:favicon-32x32.png,width:32,height:32,color:#6c44fc,links:{original_url:https://files.readme.io/285b548-favicon-32x32.png}}},custom_code:{css:.content-body .magic-block-textarea ul li, .content-body .magic-block-api-header ul li, .content-body .magic-block-textarea ol li, .content-body .magic-block-api-header ol li {\n margin-bottom: 0.15em;\n},js:null,html:{header:null,home_footer:null,page_footer:null}},header:{type:gradient,gradient_color:#5f4df7,link_style:buttons,overlay:{fill:cover,type:grain,position:center-center,image:{uri:null,url:https://files.readme.io/db60208-docbg.jpg,name:docbg.jpg,width:1920,height:320,color:#7c62ef,links:{original_url:null}}}},ai:{dropdown:enabled,options:{chatgpt:enabled,claude:enabled,clipboard:enabled,view_as_markdown:enabled,ask_ai:disabled}},navigation:{breadcrumbs:disabled,first_page:landing_page,left:,logo_link:homepage,page_icons:enabled,right:,sub_nav:,subheader_layout:dropdown,version:disabled,links:{home:{label:Home,visibility:enabled},graphql:{label:GraphQL,visibility:disabled},guides:{label:Guides,alias:Documentation,visibility:enabled},reference:{label:API Reference,alias:API Reference,visibility:enabled},recipes:{label:Recipes,alias:null,visibility:disabled},changelog:{label:Changelog,alias:null,visibility:disabled},discussions:{label:Discussions,alias:null,visibility:disabled}}}},i18n:{languages:en,defaultLanguage:en,state:disabled}}},version:{_id:59fc42803cf718001069b9ab,project:584bd29609104d23007d9ec9,__v:52,forked_from:5914222af865370f000b39aa,createdAt:2016-12-10T10:01:58.690Z,releaseDate:2016-12-10T10:01:58.690Z,categories:584bd29609104d23007d9ecd,584bd774c4655b3900f8ab36,584bd78c09104d23007d9ed3,59fc42803cf718001069b924,59fc42803cf718001069b925,59fc42803cf718001069b926,59fc42803cf718001069b927,59fc42803cf718001069b928,585a70cfbe5b1c0f004f29a3,59fc42803cf718001069b929,59fc42803cf718001069b92a,59fc42803cf718001069b92b,5914222af865370f000b3955,59fc42803cf718001069b92c,59fc42803cf718001069b92d,59fc42803cf718001069b92e,59fc42803cf718001069b92f,59fc42803cf718001069b930,59fc42803cf718001069b931,59fc42803cf718001069b932,59fc42803cf718001069b933,5a3903d196654b002ae85841,5a39040d1ef072001e686f72,5a390442489d6a002683b1e1,5b290ac63187ed0003a39f79,5b6d89a09d346300038baf55,5bd9acb4608df7005518e47f,5c9b6d0ba42eb00024b4af2c,5c9b9f9ba1cc170039471288,5d273ddba3d7360243d48bab,5d2c76b7059ba7014799b44d,5d569fa6251176006d5c0d2b,5d5bf6b77913cf004e75718a,5d8abb9de6d3f900f7070309,5d8abbeb669e910036e59639,5d8abde8192ec60031349236,5d8abe2605260200d46221af,5d8abe6e24e071001806f5d4,5d8abeb7e83f7e0024e19045,5d8ac09de7b73f03363d49d0,5d8ac1aefc49f804578a0c29,5d8ac23b0c03c3002f58fc69,5d8ac5fa5478da001f7f3537,5d8e9953589ec60039e75d85,5d8e99f1ebdd2c006b877e2c,5d8e9a98c4c04c00696b57ce,5d8e9b7719f4740011d43b8d,5d8e9bc3f4e44300312dd1bb,5d8e9c39f4e44300312dd1cb,5d8e9cdeebdd2c006b877e54,5d8e9ea50f3b8a002575a34f,5d8e9f9ef9188300738106b9,5d8ea00cfb26fa001c90b791,5d8ea08fd89cd90046594b54,5d8ea140589ec60039e75ddd,5d8ea1e2255ef80065c71ab8,5d8ea25e31d0eb00385066e0,5d8ea29a4794a30018945b3a,5d933029747232001ae76e84,5d9330eb95026a001227fbf4,5d93554cc986080018662575,5db32d82109f9600329bdad6,5db32dc5452066001d83c183,5db32dff3ad555003555560e,5dc53a440d5f2d004363aee2,5dce9fdc841080003e5bb4f8,5e1322c3db64cf00124a906e,5e3425a097e32d020fa788b6,5e3437c6233acb01e8cb4e9e,5e426a35dd81f5001b88b670,5e426de8bedf32005fb53c29,5e4270a063f8090073f32bfc,5e57cf5e9c7e970072b7dcf5,60cc8f7014124402d889f543,6376bede127d990003169164,67c87f5f8987170010065a43,68c16049f45d950727146b92,is_deprecated:false,is_hidden:false,is_beta:false,is_stable:true,codename:MessageRead,version_clean:1.0.0,version:1.0,updatedAt:2025-09-10T11:26:01.346Z}},i18n:{language:en,translations:{en:{common:{ai:{aiOpenFailed:Failed to open SuperHub AI panel.,askAi:Ask AI,askAiAriaLabel:Open Ask AI Assistant,mdCopy:Copy Markdown,mdOpenFailed:Failed to open as markdown,mdView:View as Markdown,noMdToCopy:No markdown content available to copy.,openFailed:Failed to open {{option}}.},apiConfig:{allRequests:All Requests,allRequestsFilter:All Requests,apiKeysNotFound:No API keys found.,apiKeysNotSynced:API keys are not synced with this developer hub.,apiRequests:API Requests,authentication:Authentication,credentials:Credentials,dayFilter:Last 24 Hours,emptyStatePrompt:Make a request to see them here or \u003ca>Try It\u003c/a>!,error:Error,errorRequestsFilter:400 & 500,gettingStarted:Getting Started,logInPrompt:Log in to see your API keys,monthFilter:Last 30 Days,moreErrors:More Errors,moreRequests:More Requests,myRecentErrors:My Recent Errors,myRecentRequests:My Recent Requests,myRequests:My Requests,myTopEndpoints:My Top Endpoints,personalizedDocsSetup:Set up \u003cButton>Personalized Docs\u003c/Button> to show users their API keys.,pickALanguage:Pick a language,popularEndpoints:Popular Endpoints,success:Success,weekFilter:Past week,yourApiKeys:Your API Keys},attribution:by {{attribution}},auth:{any:any,apiKey:API Key,apiKeyPrompt:Get API Key,apiKeyShow:Show API Key,apiKeyHide:Hide API Key,apiKeyToggle:Toggle API Key,apiInfo:API Info,authenticate:Authenticate,authorize:Authorize,authorizationUrl:Authorization URL,authorizedScopes:Authorized scopes for this token,authorizedScopesEmpty:Token has no authorized scopes,bearer:Bearer,clientId:Client ID,credentialMessage:{{projectName}} accepts {{count}} credential methods. You can use {{option}} of them.,credentialsFor:Credentials for {{name}},credentialsForMd:Credentials for `{{name}}`,either:eitherLog in to use your API keys,grantType:Grant Type,info:{base64:Your username and password will be combined with a : to form a base64-encoded string: `ENCODED_TOKEN`,basic:Your username and password are being sent in the header(https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) of the request.,bearer:\n Bearer authentication gives access to the “bearer of the token” and must be sent in the Authorization header. For example:\n ```bash\n curl --request POST \\\n --url https://httpbin.org/anything/bearer\n --header Authorization: Bearer BEARER_TOKEN\n ```\n ,cookie:Your API Key is being sent as a cookie(https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies).,header:Your API Key is sent in the request header(https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).,jwt:The bearer tokens format is JSON Web Token (JWT). Read more at JWT.io(https://jwt.io/).,query:Your API Key is being sent as a query parameter in the URL(https://developer.mozilla.org/en-US/docs/Web/API/URL).},infoTable:{contact:Contact,description:Description,identifier:Identifier,license:License,name:Name,termsOfService:Terms of Service,title:Title,summary:Summary,url:URL,version:Version},information:Information,label:Label,lastUsed:Last Used,logInPrompt:Log in to use your API keys,logIn:Log In,logOut:Log Out,password:password,passwordHideLabel:Hide,passwordShowLabel:Show,reAuthorize:Re-Authorize,required:required,requiredScopes:Required Scopes,requiredScopesMissingMsg_one:Missing {{count}} required scope,requiredScopesMissingMsg_other:Missing {{count}} required scopes,scopes:Scopes,scopesMissingCount:({{count}} missing from this token),scopesMissingMsg_one:This operation requires {{count}} additional scope,scopesMissingMsg_other:This operation requires {{count}} additional scopes,scopesRequiredMsg:Scopes required for this operation,scopesRequiredNoneMsg:No scopes required for this operation,selectCredentials:Select Credentials,token:token,tokenDetails:Token Details,tokenRotationMessage:We recommend you rotate this token.,tokenUrl:Token URL,useOwnToken:Use Your Own Token,username:username},close:Close,colorScheme:{dark:Dark,light:Light,system:System,title:Color Scheme},changelog:{added:Added,deprecated:Deprecated,fixed:Fixed,improved:Improved,removed:Removed,title:Changelog},copyToClipboard:{copiedFull:Copied to clipboard!,copiedShort:Copied!,copyFull:Copy to clipboard,copyShort:Copy,failed:Failed to copy to clipboard.,unable:Unable to copy},discussions:{addCommentLabel:Add Comment,adminLabel:Admin,answered:Answered,askQuestion:Ask a Question,backToAll:Back to all,blankBodyError:Your post body cannot be blank.,blankCommentError:Your comment cannot be blank.,blankPostError:Your post cannot be blank.,blankTitleError:Your post title cannot be blank.,cancelButtonLabel:Cancel,commentAndMarkAnswered:Comment and mark answered,commentAndReopen:Comment and reopen,deleteButtonLabel:Delete,deleteCommentConfirmation:Are you sure you want to delete this comment?,deleteCommentPermanentConfirmation:Are you sure you want to permanently delete this comment?,deleteComentSuccess:This comment has been deleted,deletePermanentlyButtonLabel:Permanently Delete,deletePostConfirmation:Are you sure you want to delete this post?,editButtonLabel:Edit,editedLabel:edited,emailInputAriaLabel:name@email.com,emailInputPlaceholder:Your Email,errorMessagePrefix:Error:,faqAddLabel:Add to FAQ,faqRemoveLabel:Remove from FAQ,faqsLabel:FAQs,logInToComment:\u003cb>Log in\u003c/b> to add a comment.,markAsAnswered:Mark as answered,markAsUnanswered:Mark as unanswered,markCommentSpamLabel:Mark this comment as spam,markPostSpamLabel:Mark this post as spam,nameAndEmailError:Please fill out your name and email.,nameInputAriaLabel:Your name,nameInputPlaceholder:Full name,permanentlyDeleteLabel:Permanently delete,questionInputAriaLabel:New question,recaptchaInvalidError:Invalid ReCaptcha tokens.,recaptchaRequiredError:Please complete the reCaptcha verification.,recentLabel:Recent,saveButtonLabel:Save,submitButtonLabel:Post Question,tagButtonLabel:Tag,tagInputPlaceholder:Enter tag,titleInputAriaLabel:Question title,titleInputPlaceholder:Your question title,unansweredLabel:Unanswered,voteCountLabel:{{count}} vote,voteCountLabel_plural:{{count}} votes},emptyState:{changelog:{title:No Changelogs},discussion:{actionLabel:New Question,description:Nobodys asked a question yet. Be the first!,title:No Discussions},guide:{title:No Guides},recipe:{title:No Recipes},reference:{title:No API Endpoints}},more:more…,next:Next,onlyVisibleToAdmins:Only visible to ReadMe admins,owlbotChat:{assistant:Assistant,clearChat:Clear chat history,closeChat:Close chat,emptyMessage:I’ll help you find answers in the docs,emptyTitle:Ask AI,failureTitle:Ask AI,fallbackHeading:Something went wrong with Ask AI,fallbackMessage:Please try refreshing the page or contact support if the problem persists.,inputPlaceholder:Ask a question,sendFailure:Failed to send message. Please try again.,tryAgain:Try Again,typingLabel:Generating,voteFailure:Failed to record vote. It may take a moment for the message to be saved. Please try again.,voteLabelDown:Not helpful,voteLabelUp:Helpful},pageNotFound:{heading:Page Not Found,metaTitle:404 Not Found},pageThumbs:{no:No,placeHolder:Leave an optional comment…,prompt:Did this page help you?,submit:Vote,thankYou:Thanks for voting!,yes:Yes},poweredBy:Powered by,recipes:{inThisRecipe:In this Recipe,openRecipe:Open Recipe,step_one:{{count}} step,step_other:{{count}} steps},reference:{callback:Callback,clearExample:Clear Example,clearResponse:Clear Response,data:Data,example:Example,examplePrompt:Choose an example,examplePromptOr:Or choose an example,examples:Examples,headers:Headers,invalidJSON:Invalid JSON,inspectRequest:Inspect Request,jsonEditorAriaLabel:Toggle Raw JSON Editor,jsonEditorLabel:Edit JSON Body,language:Language,library:Library,log:Log,logsLoading:Retrieving recent requests…,logsPrompt:Make a request to see history.,logsSeeAllLabel:See All Requests,logsStatusLabel:Status,logsThisMonth_one:{{count}} Request This Month,logsThisMonth_other:{{count}} Requests This Month,logsTimeLabel:Time,logsUserAgentLabel:User Agent,payloadExample:Payload Example,recentRequests:Recent Requests,replayRequest:Replay Request,request:Request,requestExample:Request Example,requestExamples:Request Examples,requestHistoryPrompt:Log in to see full request history,requestInstructions:Request instructions,resetBody:Reset Body,response:Response,sdkCodeEmpty:No SDK code available,sdkCodeError:Error retrieving SDK code. Please try again later.,tryIt:Try It,tryItPrompt:Click \u003ccode>Try It!\u003c/code> to start a request and see the response here!,tryItPunctuated:Try It!},search:{askFailure:We had an issue responding, please try again later,filtersLabel:Filters,filtersPlaceholder:Filter,forMore:for more,fromTheDocs:From the Docs,inProject:in {{project}},noResults:No search results for {{query}},placeholder:Search,pressEnterToAskAi:Press \u003ckbd>Enter\u003c/kbd> to ask AI,promptEmpty:Start typing to search…,promptLoading:Keep typing to search…,searching:Searching…,thinking:Thinking},sections:{all:All,apiLogs:API Logs,changelog:Changelog,discussions:Discussions,guides:Guides,graphql:GraphQL,home:Home,pages:Pages,recipes:Recipes,reference:API Reference},tableOfContents:Table of Contents,time:{absolute:{noPrefix:{{time}},noPrefixAttributed:{{time}} by {{attribution}},postedPrefix:Posted {{time}},postedPrefixAttributed:Posted {{time}} by {{attribution}},updatedPrefix:Updated {{time}},updatedPrefixAttributed:Updated {{time}} by {{attribution}}},justNow:{noPrefix:Less than a minute ago,noPrefixAttributed:Less than a minute ago by {{attribution}},postedPrefix:Posted just now,postedPrefixAttributed:Posted just now by {{attribution}},updatedPrefix:Updated just now,updatedPrefixAttributed:Updated just now by {{attribution}}},relative:{noPrefix:{{time}},noPrefixAttributed:{{time}} by {{attribution}},postedPrefix:Posted {{time}},postedPrefixAttributed:Posted {{time}} by {{attribution}},updatedPrefix:Updated {{time}},updatedPrefixAttributed:Updated {{time}} by {{attribution}}}},unableToCopy:Unable to copy,version:{beta:Beta,default:Default,deprecated:Deprecated,hiddenLabel:Hidden Version},whatsNext:What’s Next}}}},is404:false,isFramePreview:false,isDetachedProductionSite:false,lang:en,langFull:Default,reqUrl:/,version:{_id:59fc42803cf718001069b9ab,project:584bd29609104d23007d9ec9,__v:52,forked_from:5914222af865370f000b39aa,createdAt:2016-12-10T10:01:58.690Z,releaseDate:2016-12-10T10:01:58.690Z,categories:584bd29609104d23007d9ecd,584bd774c4655b3900f8ab36,584bd78c09104d23007d9ed3,59fc42803cf718001069b924,59fc42803cf718001069b925,59fc42803cf718001069b926,59fc42803cf718001069b927,59fc42803cf718001069b928,585a70cfbe5b1c0f004f29a3,59fc42803cf718001069b929,59fc42803cf718001069b92a,59fc42803cf718001069b92b,5914222af865370f000b3955,59fc42803cf718001069b92c,59fc42803cf718001069b92d,59fc42803cf718001069b92e,59fc42803cf718001069b92f,59fc42803cf718001069b930,59fc42803cf718001069b931,59fc42803cf718001069b932,59fc42803cf718001069b933,5a3903d196654b002ae85841,5a39040d1ef072001e686f72,5a390442489d6a002683b1e1,5b290ac63187ed0003a39f79,5b6d89a09d346300038baf55,5bd9acb4608df7005518e47f,5c9b6d0ba42eb00024b4af2c,5c9b9f9ba1cc170039471288,5d273ddba3d7360243d48bab,5d2c76b7059ba7014799b44d,5d569fa6251176006d5c0d2b,5d5bf6b77913cf004e75718a,5d8abb9de6d3f900f7070309,5d8abbeb669e910036e59639,5d8abde8192ec60031349236,5d8abe2605260200d46221af,5d8abe6e24e071001806f5d4,5d8abeb7e83f7e0024e19045,5d8ac09de7b73f03363d49d0,5d8ac1aefc49f804578a0c29,5d8ac23b0c03c3002f58fc69,5d8ac5fa5478da001f7f3537,5d8e9953589ec60039e75d85,5d8e99f1ebdd2c006b877e2c,5d8e9a98c4c04c00696b57ce,5d8e9b7719f4740011d43b8d,5d8e9bc3f4e44300312dd1bb,5d8e9c39f4e44300312dd1cb,5d8e9cdeebdd2c006b877e54,5d8e9ea50f3b8a002575a34f,5d8e9f9ef9188300738106b9,5d8ea00cfb26fa001c90b791,5d8ea08fd89cd90046594b54,5d8ea140589ec60039e75ddd,5d8ea1e2255ef80065c71ab8,5d8ea25e31d0eb00385066e0,5d8ea29a4794a30018945b3a,5d933029747232001ae76e84,5d9330eb95026a001227fbf4,5d93554cc986080018662575,5db32d82109f9600329bdad6,5db32dc5452066001d83c183,5db32dff3ad555003555560e,5dc53a440d5f2d004363aee2,5dce9fdc841080003e5bb4f8,5e1322c3db64cf00124a906e,5e3425a097e32d020fa788b6,5e3437c6233acb01e8cb4e9e,5e426a35dd81f5001b88b670,5e426de8bedf32005fb53c29,5e4270a063f8090073f32bfc,5e57cf5e9c7e970072b7dcf5,60cc8f7014124402d889f543,6376bede127d990003169164,67c87f5f8987170010065a43,68c16049f45d950727146b92,is_deprecated:false,is_hidden:false,is_beta:false,is_stable:true,codename:MessageRead,version_clean:1.0.0,version:1.0,updatedAt:2025-09-10T11:26:01.346Z}}/script>/div>div idhub-container>div classhub-container>div state-container ng-attr-id{{state.current().root ! docs && react-app-content-container}}>div idreplace-view ng-non-bindable>/div>/div>/div>/div>script>var is_hub true;var is_hub2 true;var is_hub_edit true;/script>div idssr-end>script id__LOADABLE_REQUIRED_CHUNKS__ typeapplication/json>2852,1456,3766,6563,6123,5026,6146,1617,1402,8850,6825,7752,4986,3678,6306,6083,3057,3787,5798/script>script id__LOADABLE_REQUIRED_CHUNKS___ext typeapplication/json>{namedChunks:routes-SuperHub,Header,RDMD,index,routes-Landing,Footer}/script>script async data-chunkmain srchttps://cdn.readme.io/public/hub/web/main.806058b4f4e888a778d0.js>/script>script async data-chunkroutes-SuperHub srchttps://cdn.readme.io/public/hub/web/routes-SuperHub.56f6c06b0330648b0a5a.js>/script>script async data-chunkHeader srchttps://cdn.readme.io/public/hub/web/Header.fb8b328025fcf3d323a8.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/3766.b6d2e3abde0d888cc685.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/6563.17a0dc96c8f90ede2986.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/6123.49a3637ce0366b21ac76.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/5026.d45551fe6a0c387bfbf3.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/6146.cb8f37a2ef0ab72d4bf7.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/1617.8b58072ca1f43ebe9335.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/1402.3d5f34dc903e8d858221.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/8850.d1e8a4322360350858ab.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/6825.a2791b642c85615e3e48.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/7752.c90354ae98c32b8ff740.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/4986.8c84c96194bf13b046d6.js>/script>script async data-chunkRDMD srchttps://cdn.readme.io/public/hub/web/RDMD.7113824b8cf2c57765a3.js>/script>script async data-chunkindex srchttps://cdn.readme.io/public/hub/web/6306.5e9980ce77e94d962e78.js>/script>script async data-chunkindex srchttps://cdn.readme.io/public/hub/web/6083.37273c905f7c86da051d.js>/script>script async data-chunkindex srchttps://cdn.readme.io/public/hub/web/index.f4457e32e66038d1fd03.js>/script>script async data-chunkroutes-Landing srchttps://cdn.readme.io/public/hub/web/routes-Landing.a45af69b7b4425698483.js>/script>script async data-chunkFooter srchttps://cdn.readme.io/public/hub/web/Footer.1b7490d3d8625b3ad4c4.js>/script>/div>script asyncasync srchttps://www.googletagmanager.com/gtag/js?idG-LC06P3QKXT>/script>script>window.dataLayer window.dataLayer || ;function gtag(){dataLayer.push(arguments);}gtag(js, new Date());gtag(config, G-LC06P3QKXT);/script>script idhub-me typeapplication/json data-json{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"NDZhOTVhMDMxNzgxMWQyYjdjMzM5MDMwOGU0ZDYzNGNjOTIyYjY5MWU1ODUwMmRhZDYwZGZjYTE2N2Y1ZWFjM3RhZ0ZpbHRlcnM9KHByb2plY3Q6NTg0YmQyOTYwOTEwNGQyMzAwN2Q5ZWM5KSwodmVyc2lvbjpub25lLHZlcnNpb246NTlmYzQyODAzY2Y3MTgwMDEwNjliOWFiKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ","filters":"tagFilters(project:584bd29609104d23007d9ec9),(version:none,version:59fc42803cf718001069b9ab),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":{"modules":{"reference":true,"examples":true,"docs":true,"landing":true,"suggested_edits":true,"discuss":false,"changelog":false,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"584bd29609104d23007d9ec9","name":"Amio","subdomain":"amio","subpath":"","nav_names":{"discuss":"","docs":"Documentation","reference":"API Reference","changelog":"","tutorials":"","recipes":""}}}}>/script>script idreadme-data-baseUrl typeapplication/json data-json"/">/script>/body>/html>
View on OTX
|
View on ThreatMiner
Please enable JavaScript to view the
comments powered by Disqus.
Data with thanks to
AlienVault OTX
,
VirusTotal
,
Malwr
and
others
. [
Sitemap
]