Truecaller for Business
Verified Business APIs
Verified Business APIs
  • Getting Started
    • Authentication
    • [POST] Generate Access Token
  • Call Me Back
  • User Feedback
  • Call Personalisation
    • [POST] Call Personalisation (Bulk)
    • [POST] Call Personalisation
    • [GET] Batch Status
    • [GET] Call Personalisation Label
  • Number Management
    • [POST] Number listing
    • [POST] Number delisting
    • [GET] Number details
    • [GET] Feature-set ID
  • Webhooks
    • Configure webhooks
    • Webhook name & URL
    • Webhook Events
    • Response Structure
    • Event Types
    • Test Webhook
    • Update or Remove Webhooks
    • Webhook Timeouts
    • Automatic Retries
    • Error scenarios for Webhooks
  • Call Reason Errors
Powered by GitBook

© 2024 Truecaller AB

On this page
  • Payload - Call Me Back
  • Payload - User Feedback

Was this helpful?

Export as PDF
  1. Webhooks

Response Structure

Configure your systems to consume webhook response by assigning appropriate fields to the below scenarios :

Payload - Call Me Back

#For Customers with Slot Picker

// For Customers with Slot Picker - Scenario 1
// Happy Flow

{
  "event_id": "91584c0f-32a8-11ef-a9e4-5a5798f0",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa163",
  "event_type": "cmb",
  "created_at": "1719288504",
  "cmb_payload": {
    "business_number": "0806951XXXX",
    "feature_set": "cmb",
    "client_number": "919112345678",
    "alternate_number": null, 
    "requested_at": "1719288504",
    "requested_date": "26 June 2024",
    "requested_slot": "tomorrow",
    "preferred_from_time": "1719288504",
    "preferred_to_time": "1719288504",
    "is_interested": true,  
  }
}
// For Customers with Slot Picker - Scenario 2
// SIMinfo related issues on device

{
  "event_id": "91584c0f-32a8-11ef-a9e4-5a5798f0",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa163",
  "event_type": "cmb",
  "created_at": "1719288504",
  "cmb_payload": {
    "business_number": "0806951XXXX",
    "feature_set": "cmb",
    "client_number": "Phone number not available",
    "alternate_number": "919912345678", 
    "requested_at": "1719288504",
    "requested_date": "26 June 2024",
    "requested_slot": "tomorrow",
    "preferred_from_time": "1719288504",
    "preferred_to_time": "1719288504",
    "is_interested": true,  
  }
}

// For Customers with Slot Picker - Scenario 3 
// Customers who are Not Interested 

{
  "event_id": "91584c0f-32a8-11ef-a9e4-5a5798f0",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa163",
  "event_type": "cmb",
  "created_at": "1719288504",
  "cmb_payload": {
    "business_number": "0806951XXXX",
    "feature_set": "cmb",
    "client_number": "08047360",
    "alternate_number": null, 
    "requested_at": "1719288504",
    "requested_date": "",
    "requested_slot": "",
    "preferred_from_time": null,
    "preferred_to_time": null,
    "is_interested": false,  
  }
}

#For Customers without Slot Picker

// For Customers without Slot Picker

{
  "event_id": "91584c0f-32a8-11ef-a9e4-5a5798f0",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa163",
  "event_type": "cmb",
  "created_at": "1719288504",
  "cmb_payload": {
    "business_number": "0806951XXXX",
    "feature_set": "cmb",
    "client_number": "08047360",
    "alternate_number": null, 
    "requested_at": "1719288504",
    "requested_date": "26 June 2024",
    "requested_slot": "tomorrow",
    "preferred_from_time": null,
    "preferred_to_time": null,
    "is_interested": true,  
  }
}

Payload - User Feedback

{
  "event_id": "d9f0c752-32a8-11ef-af53-3e643cc47",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa1638",
  "event_type": "user_feedback",
  "created_at": "1719288626",
  "survey_payload": {
    "business_number": "080698XXXXXX",
    "feature_set": "user_feedback_numbers",
    "client_number": "0804736XXXX",
    "requested_at": "1719288626",
    "user_responses": [
      {
        "question": "Did you find our services helpful?",
        "response": "Yes, very helpful!"
      }
    ]
  }
}

PreviousWebhook EventsNextEvent Types

Last updated 5 hours ago

Was this helpful?