API
SMS और कॉल
अपने एजेंट की फ़ोन लाइन से SMS भेजें और AI से कॉल करवाएँ
# SMS और कॉल > अपने एजेंट की फ़ोन लाइन से SMS भेजें और AI से कॉल करवाएँ - पेज: https://tbit.app/hi/docs/api/sms-calls - Base URL: `https://rest-api.tbit.app/v1` - ऑथेंटिकेशन: हर request में आपकी key के साथ `X-API-Key` header (उदाहरण इसे `TBIT_API_KEY` environment variable से पढ़ते हैं) ## सारांश दोनों आपके एजेंट की फ़ोन लाइन से जाते हैं (जो आप Plugins › फ़ोन लाइन में खरीदते हैं) और आपके प्लान की ऊर्जा खर्च करते हैं। भेजा गया हर SMS TBit में संपर्क की बातचीत में सहेजा जाता है (संपर्क न हो तो बनाया जाता है), और आपको आने वाले SMS आपके इनबॉक्स में SMS चैनल पर दिखते हैं। ## एंडपॉइंट | Method | Path | विवरण | | --- | --- | --- | | `POST` | `/v1/sms` | SMS भेजें | | `POST` | `/v1/calls` | AI से किसी नंबर पर कॉल करवाएँ | ## आवश्यकताएँ - API कुंजी वाले एजेंट पर एक सक्रिय फ़ोन लाइन। - पर्याप्त ऊर्जा: भेजने या कॉल करने से पहले इसकी जाँच होती है, और कम हो तो कुछ नहीं जाता (402)। - +1 नंबरों (अमेरिका, कनाडा, प्यूर्टो रिको…) पर SMS के लिए व्यवसाय का 10DLC पंजीकरण चाहिए; तब तक जवाब 422 होता है। हर नंबर की अपनी क्षमताएँ हैं: अगर लाइन उस गंतव्य पर SMS नहीं भेज सकती, तो जवाब में ऑपरेटर का कारण आता है (502)। ## SMS भेजें फ़ील्ड: to (E.164 फ़ॉर्मैट में नंबर, + और देश कोड के साथ), text (1,530 अक्षरों तक) और from (वैकल्पिक: E.164 में एजेंट की लाइनों में से एक, या 1 से 11 अक्षरों/नंबरों का अल्फ़ान्यूमेरिक प्रेषक जैसे "MiTienda", जिसे जवाब नहीं दिया जा सकता और जो +1 नंबरों के लिए काम नहीं करता; इसके बिना, सबसे पुरानी लाइन)। जवाब बताता है कि कितने हिस्से लगे और कितनी energy खर्च हुई। `POST /v1/sms` ```bash curl -X POST "https://rest-api.tbit.app/v1/sms" \ -H "X-API-Key: $TBIT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": "+573001234567", "text": "Hola Ana, tu pedido #1042 sale hoy." }' ``` Response: ```json { "id": "40319a3e-7e2c-4f4e-9b0e-2c1d5f8a9b10", "from": "+17869572575", "to": "+573001234567", "parts": 1, "energy": 3, "contact_id": "6ac9f1e6af6d42a269f21b15", "message_id": "6ac9f2a1af6d42a269f21c02" } ``` ## SMS की ऊर्जा | स्थिति | प्रति हिस्सा ऊर्जा | | --- | --- | | +1 नंबर पर भेजा गया SMS | 1 (10DLC चाहिए) | | किसी भी अन्य देश में भेजा गया SMS | `3` | | प्राप्त SMS | `1` | लंबा SMS कई हिस्सों में जाता है: 160 अक्षरों तक एक हिस्सा; इमोजी या GSM वर्णमाला से बाहर के अक्षरों के साथ 70 तक। इससे ज़्यादा होने पर हर हिस्से का शुल्क लगता है। ## कॉल का अनुरोध आपके एजेंट का AI उस उद्देश्य के साथ नंबर पर कॉल करता है जो आप reason में देते हैं (2,000 अक्षरों तक)। फ़ील्ड: to (E.164), reason और contact_id (वैकल्पिक: TBit संपर्क; इसके बिना संपर्क नंबर से खोजा जाता है और न हो तो बनाया जाता है)। जवाब 202 है: कॉल का अनुरोध हो गया। इसकी लागत 6 ऊर्जा प्रति मिनट है, जो कॉल ख़त्म होने पर ली जाती है; अभी सिर्फ़ कोलंबिया के नंबरों पर कॉल हो सकती है। सूचना मोड: अगर आप reason की जगह message (1,000 अक्षर तक) भेजते हैं, तो कॉल सिर्फ़ सूचित करता है। AI जवाब देने के कुछ सेकंड के भीतर वही टेक्स्ट बोल देता है (व्यक्ति के बोलने का इंतज़ार किए बिना), विदा कहता है और कॉल काट देता है; न बातचीत करता है न सवालों के जवाब देता है। message के साथ, reason वैकल्पिक है और संदर्भ के रूप में काम करता है। कॉल आपके एजेंट की लाइन से जाता है और उसी तरह शुल्क लिया जाता है: शुरू किए गए हर मिनट पर 6 energy। `POST /v1/calls` ```bash curl -X POST "https://rest-api.tbit.app/v1/calls" \ -H "X-API-Key: $TBIT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": "+573001234567", "reason": "Confirmar la cita de mañana a las 10:00 y ofrecer cambiarla si no puede." }' ``` Response: ```json { "call_id": "6ac9f3b7af6d42a269f21c10", "provider_call_id": "conv_8f2k1x", "from": "+576019190351", "to": "+573001234567", "contact_id": "6ac9f1e6af6d42a269f21b15", "status": "requested" } ``` `POST /v1/calls` ```bash curl -X POST "https://rest-api.tbit.app/v1/calls" \ -H "X-API-Key: $TBIT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "to": "+573001234567", "message": "Tu pago de 250 USD fue aprobado. Ya puedes verlo en tu cuenta." }' ``` ## आपको मिलने वाले SMS लाइन पर आपको लिखे गए SMS TBit के इनबॉक्स में प्रति SMS एक बातचीत के रूप में दिखते हैं। AI उनका जवाब नहीं देता। हर एक पर प्रति भाग 1 energy खर्च होती है। ## सीमाएँ प्रति मिनट 100 अनुरोधों की सामान्य सीमा के अलावा, इनमें से हर endpoint प्रति एजेंट प्रति मिनट 30 तक स्वीकार करता है। ## त्रुटियाँ | स्थिति | कोड | विवरण | | --- | --- | --- | | `409` | `NO_PHONE_LINE` | एजेंट के पास सक्रिय फ़ोन लाइन नहीं है | | `422` | `DESTINATION_NOT_ALLOWED` | गंतव्य अभी सक्षम नहीं है (+1 को 10DLC चाहिए) | | `402` | `INSUFFICIENT_ENERGY` | energy पर्याप्त नहीं है; न भेजा गया न कॉल किया गया | | `502` | `PROVIDER_ERROR` | ऑपरेटर ने भेजना या कॉल अस्वीकार कर दिया; message में उसका कारण है |दोनों आपके एजेंट की फ़ोन लाइन से जाते हैं (जो आप Plugins › फ़ोन लाइन में खरीदते हैं) और आपके प्लान की ऊर्जा खर्च करते हैं। भेजा गया हर SMS TBit में संपर्क की बातचीत में सहेजा जाता है (संपर्क न हो तो बनाया जाता है), और आपको आने वाले SMS आपके इनबॉक्स में SMS चैनल पर दिखते हैं।
| Method | Path | विवरण |
|---|---|---|
| POST | /v1/sms | SMS भेजें |
| POST | /v1/calls | AI से किसी नंबर पर कॉल करवाएँ |
- API कुंजी वाले एजेंट पर एक सक्रिय फ़ोन लाइन।
- पर्याप्त ऊर्जा: भेजने या कॉल करने से पहले इसकी जाँच होती है, और कम हो तो कुछ नहीं जाता (402)।
- +1 नंबरों (अमेरिका, कनाडा, प्यूर्टो रिको…) पर SMS के लिए व्यवसाय का 10DLC पंजीकरण चाहिए; तब तक जवाब 422 होता है। हर नंबर की अपनी क्षमताएँ हैं: अगर लाइन उस गंतव्य पर SMS नहीं भेज सकती, तो जवाब में ऑपरेटर का कारण आता है (502)।
फ़ील्ड: to (E.164 फ़ॉर्मैट में नंबर, + और देश कोड के साथ), text (1,530 अक्षरों तक) और from (वैकल्पिक: E.164 में एजेंट की लाइनों में से एक, या 1 से 11 अक्षरों/नंबरों का अल्फ़ान्यूमेरिक प्रेषक जैसे "MiTienda", जिसे जवाब नहीं दिया जा सकता और जो +1 नंबरों के लिए काम नहीं करता; इसके बिना, सबसे पुरानी लाइन)। जवाब बताता है कि कितने हिस्से लगे और कितनी energy खर्च हुई।
/v1/smscurl -X POST "https://rest-api.tbit.app/v1/sms" \
-H "X-API-Key: $TBIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+573001234567",
"text": "Hola Ana, tu pedido #1042 sale hoy."
}'const response = await fetch('https://rest-api.tbit.app/v1/sms', {
method: 'POST',
headers: {
'X-API-Key': process.env.TBIT_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
to: '+573001234567',
text: 'Hola Ana, tu pedido #1042 sale hoy.',
}),
});
const data = await response.json();import axios from 'axios';
const { data } = await axios.post(
'https://rest-api.tbit.app/v1/sms',
{
to: '+573001234567',
text: 'Hola Ana, tu pedido #1042 sale hoy.',
},
{
headers: {
'X-API-Key': process.env.TBIT_API_KEY,
},
},
);import os
import requests
response = requests.post(
'https://rest-api.tbit.app/v1/sms',
headers={'X-API-Key': os.environ['TBIT_API_KEY']},
json={
'to': '+573001234567',
'text': 'Hola Ana, tu pedido #1042 sale hoy.',
},
)
data = response.json()<?php
$ch = curl_init('https://rest-api.tbit.app/v1/sms');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-Key: ' . getenv('TBIT_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'to' => '+573001234567',
'text' => 'Hola Ana, tu pedido #1042 sale hoy.',
]),
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);{
"id": "40319a3e-7e2c-4f4e-9b0e-2c1d5f8a9b10",
"from": "+17869572575",
"to": "+573001234567",
"parts": 1,
"energy": 3,
"contact_id": "6ac9f1e6af6d42a269f21b15",
"message_id": "6ac9f2a1af6d42a269f21c02"
}| स्थिति | प्रति हिस्सा ऊर्जा |
|---|---|
| +1 नंबर पर भेजा गया SMS | 1 (10DLC चाहिए) |
| किसी भी अन्य देश में भेजा गया SMS | 3 |
| प्राप्त SMS | 1 |
लंबा SMS कई हिस्सों में जाता है: 160 अक्षरों तक एक हिस्सा; इमोजी या GSM वर्णमाला से बाहर के अक्षरों के साथ 70 तक। इससे ज़्यादा होने पर हर हिस्से का शुल्क लगता है।
आपके एजेंट का AI उस उद्देश्य के साथ नंबर पर कॉल करता है जो आप reason में देते हैं (2,000 अक्षरों तक)। फ़ील्ड: to (E.164), reason और contact_id (वैकल्पिक: TBit संपर्क; इसके बिना संपर्क नंबर से खोजा जाता है और न हो तो बनाया जाता है)। जवाब 202 है: कॉल का अनुरोध हो गया। इसकी लागत 6 ऊर्जा प्रति मिनट है, जो कॉल ख़त्म होने पर ली जाती है; अभी सिर्फ़ कोलंबिया के नंबरों पर कॉल हो सकती है।
सूचना मोड: अगर आप reason की जगह message (1,000 अक्षर तक) भेजते हैं, तो कॉल सिर्फ़ सूचित करता है। AI जवाब देने के कुछ सेकंड के भीतर वही टेक्स्ट बोल देता है (व्यक्ति के बोलने का इंतज़ार किए बिना), विदा कहता है और कॉल काट देता है; न बातचीत करता है न सवालों के जवाब देता है। message के साथ, reason वैकल्पिक है और संदर्भ के रूप में काम करता है। कॉल आपके एजेंट की लाइन से जाता है और उसी तरह शुल्क लिया जाता है: शुरू किए गए हर मिनट पर 6 energy।
/v1/callscurl -X POST "https://rest-api.tbit.app/v1/calls" \
-H "X-API-Key: $TBIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+573001234567",
"reason": "Confirmar la cita de mañana a las 10:00 y ofrecer cambiarla si no puede."
}'const response = await fetch('https://rest-api.tbit.app/v1/calls', {
method: 'POST',
headers: {
'X-API-Key': process.env.TBIT_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
to: '+573001234567',
reason: 'Confirmar la cita de mañana a las 10:00 y ofrecer cambiarla si no puede.',
}),
});
const data = await response.json();import axios from 'axios';
const { data } = await axios.post(
'https://rest-api.tbit.app/v1/calls',
{
to: '+573001234567',
reason: 'Confirmar la cita de mañana a las 10:00 y ofrecer cambiarla si no puede.',
},
{
headers: {
'X-API-Key': process.env.TBIT_API_KEY,
},
},
);import os
import requests
response = requests.post(
'https://rest-api.tbit.app/v1/calls',
headers={'X-API-Key': os.environ['TBIT_API_KEY']},
json={
'to': '+573001234567',
'reason': 'Confirmar la cita de mañana a las 10:00 y ofrecer cambiarla si no puede.',
},
)
data = response.json()<?php
$ch = curl_init('https://rest-api.tbit.app/v1/calls');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-Key: ' . getenv('TBIT_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'to' => '+573001234567',
'reason' => 'Confirmar la cita de mañana a las 10:00 y ofrecer cambiarla si no puede.',
]),
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);{
"call_id": "6ac9f3b7af6d42a269f21c10",
"provider_call_id": "conv_8f2k1x",
"from": "+576019190351",
"to": "+573001234567",
"contact_id": "6ac9f1e6af6d42a269f21b15",
"status": "requested"
}/v1/callscurl -X POST "https://rest-api.tbit.app/v1/calls" \
-H "X-API-Key: $TBIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+573001234567",
"message": "Tu pago de 250 USD fue aprobado. Ya puedes verlo en tu cuenta."
}'const response = await fetch('https://rest-api.tbit.app/v1/calls', {
method: 'POST',
headers: {
'X-API-Key': process.env.TBIT_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
to: '+573001234567',
message: 'Tu pago de 250 USD fue aprobado. Ya puedes verlo en tu cuenta.',
}),
});
const data = await response.json();import axios from 'axios';
const { data } = await axios.post(
'https://rest-api.tbit.app/v1/calls',
{
to: '+573001234567',
message: 'Tu pago de 250 USD fue aprobado. Ya puedes verlo en tu cuenta.',
},
{
headers: {
'X-API-Key': process.env.TBIT_API_KEY,
},
},
);import os
import requests
response = requests.post(
'https://rest-api.tbit.app/v1/calls',
headers={'X-API-Key': os.environ['TBIT_API_KEY']},
json={
'to': '+573001234567',
'message': 'Tu pago de 250 USD fue aprobado. Ya puedes verlo en tu cuenta.',
},
)
data = response.json()<?php
$ch = curl_init('https://rest-api.tbit.app/v1/calls');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-API-Key: ' . getenv('TBIT_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'to' => '+573001234567',
'message' => 'Tu pago de 250 USD fue aprobado. Ya puedes verlo en tu cuenta.',
]),
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);लाइन पर आपको लिखे गए SMS TBit के इनबॉक्स में प्रति SMS एक बातचीत के रूप में दिखते हैं। AI उनका जवाब नहीं देता। हर एक पर प्रति भाग 1 energy खर्च होती है।
प्रति मिनट 100 अनुरोधों की सामान्य सीमा के अलावा, इनमें से हर endpoint प्रति एजेंट प्रति मिनट 30 तक स्वीकार करता है।
| स्थिति | कोड | विवरण |
|---|---|---|
409 | NO_PHONE_LINE | एजेंट के पास सक्रिय फ़ोन लाइन नहीं है |
422 | DESTINATION_NOT_ALLOWED | गंतव्य अभी सक्षम नहीं है (+1 को 10DLC चाहिए) |
402 | INSUFFICIENT_ENERGY | energy पर्याप्त नहीं है; न भेजा गया न कॉल किया गया |
502 | PROVIDER_ERROR | ऑपरेटर ने भेजना या कॉल अस्वीकार कर दिया; message में उसका कारण है |