Robofy API
HomeChangelog
HomeChangelog
Visit Website
Sign In
Create an account
    • Start Guide
      • Getting Started
      • API Reference
      • Changelog
    • Robofy API
      • Account
        • /v1/account/details
        • /v1/account/details
        • /v1/account/limit
      • Chatbot
        • /v1/ai-agent/chatbot_asset_link
        • /v1/ai-agent/chatbot/{projectId}
        • /v1/ai-agent/chatbot/{projectId}
        • /v1/ai-agent/chatbot/{projectId}/{chatbotId}
        • /v1/ai-agent/chatbot/{projectId}/{chatbotId}
        • /v1/ai-agent/chatbot/{projectId}/{chatbotId}
        • /v1/ai-agent/chatbot_asset_delink
        • /v1/ai-agent/chatbot_asset_link/{projectId}/{chatbotId}
        • /v1/ai-agent/widget/integration/{projectId}/{chatbotId}
      • Inbox
        • /v1/ai-agent/inbox/sessions/{chatbotId}
        • /v1/ai-agent/inbox/chats/{chatbotId}/{sessionId}
      • Project
        • /v1/projects
        • /v1/projects
        • /v1/projects/{id}
        • /v1/projects/{id}
      • Leads
        • /v1/ai-agent/leads/{projectId}/{chatbotId}
      • Content
        • /v1/ai-agent/crawl_website
        • /v1/ai-agent/crawl_status/{projectId}/{chatbotId}
        • /v1/ai-agent/link_content/{projectId}
      • Stats
        • /v1/ai-agent/message_stats
      • License
        • /v1/license
        • /v1/license
        • /v1/license
        • /v1/license/{licenseId}
        • /v1/license/{licenseId}
        • /v1/license/limit
      • Partner
        • /v1/partner/onboard
      • Schemas
        • Account
        • AccountDetailDto
        • Address
        • AgentCredentialInsertResponseDto
        • AgentCredentialRequestDto
        • AgentCredentialResponseDto
        • AgentDataPoint
        • AgentLeadCapture
        • AgentLeadReportDto
        • AgentLinkageDto
        • AgentMcpServerDto
        • AgentMcpServerInsertResponseDto
        • AgentMcpServerRequestDto
        • AgentMcpServerUpdateRequestDto
        • AgentPromptVersionDto
        • AgentSessionListDto
        • AgentSessionListItemDto
        • AgentStatsDto
        • AgentThemeDto
        • AgentThemeListDto
        • AgentToolLinkageInsertResponseDto
        • AgentToolLinkageRequestDto
        • AgentWhatappIntrgrationResponse
        • AgentWhatsAppLinkageDto
        • Button
        • CarouselCard
        • CategoryStats
        • ChatBotDetailsDto
        • ChatBotDetailsRequest
        • ChatBotDetailsUpdateRequest
        • ChatbotAISettingsDto
        • ChatbotAISettingsRequest
        • ChatbotAdvanceSettingsDto
        • ChatbotAdvanceSettingsRequest
        • ChatbotAppearanceSettingsDto
        • ChatbotAppearanceSettingsRequest
        • ChatbotAssetDelinkDto
        • ChatbotAssetLinkageDataDto
        • ChatbotAssetLinkageDelinkRequest
        • ChatbotAssetLinkageDetailsDto
        • ChatbotAssetLinkageDto
        • ChatbotAssetLinkageRequest
        • ChatbotTextLinkageRequest
        • ClientData
        • CommonResponse
        • Component
        • Contact
        • ContactName
        • CrawlStatusDto
        • CrawlWebsiteRequest
        • CreateOrUpdateProjectRequest
        • CreatePhoneNumberRequest
        • CreateTemplateRequest
        • CreateWebhookConfigRequest
        • DeLinkWhatsAppRequest
        • Email
        • Error
        • ErrorResponse
        • Example
        • FailureStats
        • FailureStatsDataPoint
        • FormField
        • GoogleSheetDto
        • GoogleSheetIntegrationRequest
        • InboxChatDto
        • InboxDto
        • InboxMessage
        • InboxSession
        • IntelligentMetricsDto
        • Interactive
        • InteractiveAction
        • InteractiveBody
        • InteractiveButton
        • InteractiveFooter
        • InteractiveHeader
        • InteractiveMedia
        • InteractiveProductItem
        • InteractiveProductSection
        • InteractiveReply
        • InteractiveRow
        • InteractiveSection
        • LeadCaptureForm
        • LeadData
        • LeadDataField
        • LeadFormData
        • LeadReport
        • LicenseCreateRequest
        • LicenseDto
        • LicenseLimitRequest
        • LicenseUpdateRequest
        • LimitedTimeOffer
        • LinkWhatsAppRequest
        • LinkedCredentialDto
        • LinkedMcpServerDto
        • Location
        • Media
        • MessageMetaData
        • MessageRequest
        • MessageResponse
        • MessageStats
        • MessageStatsDataPoint
        • MessageTemplate
        • NamedParameter
        • OrgLimitDto
        • Organization
        • PaginatedWebhookLogsResponse
        • Part
        • PartnerClientSession
        • PartnerClientSessionDto
        • Phone
        • PhoneNumberRequest
        • PhoneVerifyCodeRequest
        • PhoneVerifyRequest
        • PlatformStats
        • ProjectDetailDto
        • ProjectWABADetail
        • Reaction
        • ReadTypingIndicatorRequest
        • RecentInsightDto
        • Response
        • SessionInsightItemDto
        • SessionInsightsDto
        • SessionMetaDto
        • SessionMetricsDto
        • SessionSummaryDetailDto
        • StartUrl
        • SubcribedAppsRequest
        • SupportedApp
        • TemplateAction
        • TemplateButtons
        • TemplateCarousel
        • TemplateComponent
        • TemplateCurrency
        • TemplateDateTime
        • TemplateLimitedTimeOffer
        • TemplateMedia
        • TemplateParameter
        • TemplateProductItem
        • TemplateSection
        • TemplateTapTargetConfiguration
        • Text
        • ThemeMetaDto
        • TypingIndicator
        • UpdateOnboardStatusRequest
        • UpdateOnboardStatusResponseDto
        • UploadMedia
        • Url
        • WABADetail
        • WABADto
        • Webhook
        • WebhookConfigDto
        • WebhookConfiguration
        • WebhookLogDto
        • WebsiteDto
        • WhatsAppBusinessApiData
        • WhatsAppBusinessProfile
        • WidgetIntegration

    MessageRequest

    {
        "from": "string",
        "to": "string",
        "type": "string",
        "template": {
            "name": "string",
            "lang_code": "string",
            "components": [
                {
                    "type": "string",
                    "parameters": [
                        {
                            "type": "string",
                            "text": "string",
                            "currency": {
                                "fallback_value": "string",
                                "code": "string",
                                "amount_1000": 0
                            },
                            "date_time": {
                                "fallback_value": "string"
                            },
                            "image": {
                                "id": "string",
                                "link": "string",
                                "filename": "string"
                            },
                            "video": {
                                "id": "string",
                                "link": "string",
                                "filename": "string"
                            },
                            "document": {
                                "id": "string",
                                "link": "string",
                                "filename": "string"
                            },
                            "payload": "string",
                            "coupon_code": "string",
                            "action": {
                                "flow_token": "string",
                                "flow_action_data": null,
                                "thumbnail_product_retailer_id": "string",
                                "sections": [
                                    {
                                        "title": "string",
                                        "product_items": [
                                            {
                                                "product_retailer_id": "string",
                                                "catalog_id": "string"
                                            }
                                        ]
                                    }
                                ]
                            },
                            "product": {
                                "product_retailer_id": "string",
                                "catalog_id": "string"
                            },
                            "tap_target_configuration": [
                                {
                                    "url": "string",
                                    "title": "string"
                                }
                            ],
                            "limited_time_offer": {
                                "expiration_time_ms": 0
                            }
                        }
                    ],
                    "cards": [
                        {
                            "card_index": 0,
                            "components": [
                                {}
                            ]
                        }
                    ],
                    "sub_type": "string",
                    "index": 0,
                    "buttons": [
                        {
                            "type": "string",
                            "text": "string",
                            "flow_id": "string",
                            "flow_name": "string",
                            "flow_action": "string",
                            "navigate_screen": "string",
                            "flow_json": "string",
                            "icon": "string"
                        }
                    ]
                }
            ]
        },
        "text": {
            "body": "string",
            "preview_url": true
        },
        "reaction": {
            "message_id": "string",
            "emoji": "string"
        },
        "image": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "audio": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "video": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "document": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "sticker": {
            "id": "string",
            "link": "string",
            "caption": "string",
            "filename": "string",
            "provider": "string"
        },
        "location": {
            "longitude": "string",
            "latitude": "string",
            "name": "string",
            "address": "string"
        },
        "interactive": {
            "type": "string",
            "header": {
                "type": "string",
                "text": "string",
                "image": {
                    "link": "string",
                    "id": "string",
                    "caption": "string"
                },
                "video": {
                    "link": "string",
                    "id": "string",
                    "caption": "string"
                },
                "document": {
                    "link": "string",
                    "id": "string",
                    "caption": "string"
                }
            },
            "body": {
                "text": "string"
            },
            "footer": {
                "text": "string"
            },
            "action": {
                "buttons": [
                    {
                        "type": "string",
                        "reply": {
                            "id": "string",
                            "title": "string"
                        }
                    }
                ],
                "button": "string",
                "section": [
                    {
                        "title": "string",
                        "rows": [
                            {
                                "id": "string",
                                "title": "string",
                                "description": "string"
                            }
                        ]
                    }
                ],
                "catalog_id": "string",
                "product_retailer_id": "string",
                "sections": [
                    {
                        "title": "string",
                        "product_items": [
                            {
                                "product_retailer_id": "string"
                            }
                        ]
                    }
                ]
            }
        },
        "contacts": [
            {
                "addresses": [
                    {
                        "street": "string",
                        "city": "string",
                        "state": "string",
                        "zip": "string",
                        "country": "string",
                        "country_code": "string",
                        "type": "string"
                    }
                ],
                "birthday": "string",
                "emails": [
                    {
                        "email": "string",
                        "type": "string"
                    }
                ],
                "name": {
                    "formatted_name": "string",
                    "first_name": "string",
                    "last_name": "string",
                    "middle_name": "string",
                    "suffix": "string",
                    "prefix": "string"
                },
                "org": {
                    "company": "string",
                    "department": "string",
                    "title": "string"
                },
                "phones": [
                    {
                        "phone": "string",
                        "type": "string",
                        "wa_id": "string"
                    }
                ],
                "urls": [
                    {
                        "url": "string",
                        "type": "string"
                    }
                ]
            }
        ],
        "campaign_name": "string",
        "callback_data": "string",
        "schedule_time": "string",
        "is_inbox": true
    }
    Built with