Skip to main content
GET
/
api
/
v1
/
users
/
{username}
cURL
curl --request GET \
  --url https://api.myaifrontdeskdashboard.com/api/v1/users/{username} \
  --header 'Authorization: Basic <encoded-value>'
{
  "sucess": true,
  "user": {
    "buffer": "na",
    "workflowNotifSettings": {
      "scenario": "If the caller mentions anything related to billing, refunds, or payments",
      "email_recipients": [
        "[email protected]"
      ]
    },
    "sampleQA": "Q: What services do you offer? A: We offer haircuts, beard trims, hot towel shaves, and neck cleanups. Q: Do you have any availability right now? A: You can check for availability on our website.",
    "callNotifSettings": {
      "email_recipients": [
        "[email protected]"
      ],
      "voicemail_enabled": "false",
      "text_enabled": "false",
      "call_enabled": "true"
    },
    "voiceSelected": {
      "voiceId": "aura-asteria-en",
      "provider": "deepgram"
    },
    "callWorkflows": [
      {
        "description": "Transfer the caller to the billing department. Execute whenever caller asks for a refund or receipt.",
        "voiceResponse": "Sounds good, I am transferring you to the billing department right now. Please hold.",
        "workflowForwardingNumber": "+1xxxxxxxxxxx",
        "country": {
          "name": "Vietnam (+84)",
          "code": 84
        }
      }
    ],
    "demo": true,
    "selectedLanguages": [
      "English, Hindi"
    ],
    "interruptionWords": 15,
    "workflows": [
      {
        "description": "Send the caller a copy of the menu. Execute whenever caller asks for menu or prices.",
        "voiceResponse": "Here is our menu: www.restaurant.com/menu",
        "textMessage": "Great! I’ve just texted you a copy of the menu"
      }
    ],
    "voicemailsEnabled": false,
    "businessName": "My AI Frontdesk",
    "languageGreetings": {
      "Hindi": "नमस्ते, मैं आपकी कैसे मदद कर सकता हूँ?"
    },
    "aiPrompt": "From now on, you are a helpful phone receptionist at My AI Frontdesk that customers can call to ask questions. Be friendly and helpful. Never make up information that you don't know.",
    "created": "2024-06-25T11:30:22.886Z",
    "languageOptions": "na",
    "businessInformation": "Prestige Estates Realty is a dynamic player in the real estate industry, specializing in residential and commercial property transactions. With a commitment to excellence and customer satisfaction, we offer a comprehensive range of services, including property sales, leasing, and property management.\n\nOur team of experienced real estate professionals leverages market insights and cutting-edge technology to provide clients with tailored solutions that meet their unique needs. Whether you're buying, selling, or renting, ABC Realty is dedicated to delivering exceptional results and ensuring a seamless real estate experience.\n\nTo explore our available properties, list your property with us, or discuss your real estate goals, please visit our website or get in touch with our knowledgeable team.\n\nServices offered:\n- Property sales\n- Leasing\n- Property management\n- Market insights\n\nPrices:\n- Property sales: Starting from $200000\n- Leasing: Starting from $1000\n- Property management: Starting from $500\n- Market insights: Starting from $500",
    "businessType": "Other",
    "endpointing": 300,
    "username": "+1xxxxxxxxxx",
    "textingPlatformNotifSettings": {
      "enabled": true,
      "email_recipients": [
        "[email protected], [email protected]"
      ],
      "text_recipients": [
        "+1xxxxxxxxxx, +1xxxxxxxxxx"
      ]
    },
    "greetingPhrase": "Hi, welcome to My AI Frondesk. We're currently doing a 10% off summer sale. I can help you book an appointment or answer any questions you may have. How may I help you?",
    "formBuilders": [
      {
        "description": "custom-scenario",
        "customScenario": "Anytime the user says I want to introduce my pet",
        "questions": [
          "What is your pet's name?"
        ],
        "final_collection_phrase": "Thanks, I have collected your information. Is there anything else I can help you with?"
      }
    ],
    "postCallWebhook": {
      "method": "POST",
      "endpoint": "https://www.example.com/"
    },
    "callWebhookWorkflows": [
      {
        "name": "Retieval worfflow",
        "scenario": "Trigger this webhook when the caller says book an appointment for me.",
        "isRepetable": false,
        "speechToEmit": "Great! Lets get your appointment booked.",
        "timeoutSeconds": 5,
        "webhookInformation": {
          "url": "https://www.example.com",
          "method": "POST",
          "headers": {
            "headerName": "<string>"
          },
          "body": {
            "key": "<string>"
          },
          "responseData": [
            {
              "jsonPath": "data.date",
              "variableName": "date",
              "prompt": "For which date should we book an appointment with you"
            }
          ]
        },
        "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
        "extractedCallInfo": [
          {
            "name": "date",
            "type": "<unknown>",
            "example": "<unknown>",
            "enum": "<unknown>"
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

username
string
required

username of the receptionist

Example:

"johndoe"

Response

success

sucess
boolean
Example:

true

user
object