סקירה כללית
כל פעולה שמופיעה כאן היא אותה קריאת HTTP:
POST https://my.textme.co.il/api
Authorization: Bearer {api_token}
Content-Type: application/json (או application/xml)מה שמשתנה הוא אלמנט השורש של גוף הבקשה. <sms> שולח הודעה, <dlr> שולף דוחות מסירה, <newCL> יוצר רשימת תפוצה. העמוד הזה ממפה כל אלמנט שורש לעמוד שמתעד אותו.
החליפו את הכתובת ב-https://my.textme.co.il/api/test כדי לאמת גוף בקשה בלי לבצע את הפעולה — ראו מבנה הבקשה.
טוקני API
| אלמנט שורש | פעולה |
|---|---|
getApiToken | יצירת טוקן חדש, או קריאת הטוקן העדכני ביותר. דורש טוקן קיים בתוקף. |
שליחת SMS
| אלמנט שורש | פעולה |
|---|---|
sms | שליחת הודעה אחת לכל מספר יעדים ורשימות תפוצה. תזמון, נספחי הסרה, קיצור קישורים, סינון לפי מועד שליחה אחרון ומתן שם לקמפיין — כולם כאן. |
שליחה מרובה
| אלמנט שורש | פעולה |
|---|---|
bulk | שליחת עד 2,500 הודעות שונות בקריאה אחת, כל אחת עם הטקסט, השולח והיעדים שלה. |
הודעות קוליות (TTS)
| אלמנט שורש | פעולה |
|---|---|
sms + tts | פעולת sms עם בלוק tts מצורף: ההודעה נשמעת בשיחת טלפון במקום להישלח כ-SMS, או בנוסף אליו. |
יתרה
| אלמנט שורש | פעולה |
|---|---|
balance | יתרת ה-SMS שנותרה, יתרה בינלאומית, או יתרת דואר. |
דוחות
| אלמנט שורש | פעולה |
|---|---|
dlr | דוחות מסירה עבור מזהים חיצוניים שנשלחו בזמן השליחה. עד 1,000 מזהים, שבוע אחד לכל בקשה. |
dlrByDate | דוחות מסירה לחלון זמן, בלי צורך במזהים חיצוניים. שבוע אחד לכל בקשה. |
incoming | הודעות שנשלחו אל המספרים שלכם. שבוע אחד לכל בקשה, עד שנה אחורה. |
רשימת חסומים
| אלמנט שורש | פעולה |
|---|---|
blacklist | רשימת המספרים שנחסמו בטווח תאריכים. |
addNumBL | חסימת מספרים. עונה 946 בהצלחה, לא 0. |
rmNumBL | הסרת חסימה. דורש reason. עונה 944 בהצלחה חלקית. |
רשימות תפוצה
| אלמנט שורש | פעולה |
|---|---|
newCL | יצירת רשימה אחת או יותר, עם אפשרות לאכלוס, ועד שישה שדות דינמיים לכל איש קשר. |
removeCL | מחיקת רשימות לפי מזהה. |
addNumCL | הוספת מספרים לרשימות קיימות. |
rmNumCL | הסרת מספרים מרשימות קיימות. |
getCL | כל הרשימות והחברים בהן, כולל רשימות ריקות. |
getCLbyID | החברים ברשימה אחת. |
קמפיינים
| אלמנט שורש | פעולה |
|---|---|
cancel | ביטול קמפיין מתוזמן לפי campaign_id, או כל הקמפיינים התואמים ל-campaign_name. |
get_birthday_campaigns | רשימת קמפייני יום ההולדת של החשבון. |
edit_birthday_campaign | החלפת גוף ההודעה בקמפיין יום הולדת. |
מספרי שולח מאומתים
| אלמנט שורש | פעולה |
|---|---|
verify_phone | שליחת מספרים לאימות כדי שיהיו שמישים כ-source. |
getVerifiedPhones | רשימת המספרים שאומתו, עם אפשרות לכלול את אלה של חשבונות המשנה. |
מנויים
פעולות משווקים, עבור חשבונות שמנהלים חשבונות משנה.
| אלמנט שורש | פעולה |
|---|---|
addSub | יצירת חשבון משנה עם יתרת קרדיטים פותחת. |
updateAmountSub | העברת קרדיטים לארנק של חשבון משנה. |
getBlanceSubs | היתרה של כל חשבונות המשנה. |
Push API
לא משהו שאתם קוראים לו — משהו ש-TextMe קוראת לו. דוחות מסירה, הודעות נכנסות והסרות מרשימת תפוצה נשלחים ב-POST לכתובת שאתם רושמים, בפורמט form-encoded.
מבנה התשובה המשותף
כל פעולה עונה עם status ו-message, ואחריהם הנתונים שלה. status בערך 0 אומר שהקריאה נתקבלה; ראו קודי סטטוס לכל השאר, ושימו לב לשתי פעולות רשימת החסימה שמדווחות הצלחה בסטטוס שאינו אפס.
פעולות אצווה עשויות להחזיר גם מערך errors לצד status מוצלח — הקריאה עבדה, שורות מסוימות לא. ראו הצלחה חלקית.