מפתחים

POST/tcr/v2/brand/nonBlocking

רישום מותג הודעות

רשמו זהות עסקית בבעלות החשבון, שמרו על בקשות ארגז חול מפורשות, ותאמו אימות ועמלות.

בעמוד זה
  1. רשמו את העסק שמאחורי ההודעות שלכם
  2. התחילו עם בקשת ארגז חול מפורשת
  3. שדות עסק ואיש קשר
  4. שמרו על מפתח אידמפוטנטיות יציב
  5. קראו את המותג ואת מצבו
  6. עמלות ייצור
  7. טפלו בשגיאות מבלי לשכפל את המותג

רשמו את העסק שמאחורי ההודעות שלכם

מותג הודעות מזהה את העסק השולח הודעות 10DLC של ארה״ב. רשמו את המותג לפני בחירת מקרה שימוש לקמפיין. השתמשו בפרטים המשפטיים של העסק ובאיש קשר שיכול להשלים כל אימות נדרש. מזהה מותג שהוחזר אינו, כשלעצמו, אישור לשליחת הודעות.

השתמשו בנתיב עדכני זה בבעלות החשבון דרך HTTPS עם חשבון API מופעל וכתובת ה-IP המותרת של מקור הבקשה. אל תשלחו user_id, username או מזהה בעלים אחר של לקוח. MultiTEL מתעדת בעלות מתוך החשבון המאומת.

התחילו עם בקשת ארגז חול מפורשת

הטופס בפורטל מוגדר כברירת מחדל ל-mode של ארגז חול; בקשת API ישירה חייבת לכלול במפורש את הערך הבוליאני של JSON mock: true כאשר אתם מתכוונים למותג מדומה. השמטת הדגל אינה מבטיחה ארגז חול ועלולה ליצור רישום ייצור בר-חיוב. שדה ה-mode בפורטל אינו תחליף לשדה ה-mock של ה-API.

הכינו קובץ brand.json מקומי באמצעות השדות שלהלן. החליפו את שומרי המקום בפרטי בדיקה מתאימים ובקודי קטלוג עדכניים. דוגמה זו היא עסק פרטי למטרות רווח; לסוגי ישויות אחרים יש דרישות שונות.

{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "Example business",
  "companyName": "Example legal business name",
  "ein": "YOUR_TAX_ID",
  "einIssuingCountry": "US",
  "phone": "+12025550123",
  "street": "123 Example Street",
  "city": "Example City",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "contact@example.invalid",
  "brandRelationship": "BASIC_ACCOUNT",
  "vertical": "CURRENT_VERTICAL_CODE",
  "referenceId": "your-business-reference",
  "mock": true
}

העסק, הכתובת, הטלפון והמזהה לעיל הם שומרי מקום, לא זהות עסקית מוכנה לרישום. קבלו ערכים עדכניים עבור entityType, vertical, country, state, brandRelationship ורשימות ערכים אחרות מתוך קטלוגי ההודעות.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @brand.json \
  'https://api.multitel.net/tcr/v2/brand/nonBlocking'

שדות עסק ואיש קשר

שדות רישום מותג
שדותמה לספק
entityType, displayNameקוד עדכני לסוג הישות ושם המותג המוכר. האורכים המרביים הם 20 ו-255 תווים בהתאמה.
country, street, city, state, postalCodeכתובת העסק בפועל. השתמשו בקוד מדינה בן שתי אותיות ובקוד state עדכני של ארה״ב כאשר רלוונטי. מגבלות: street 255, city 100, state 20 ו-postalCode 10 תווים.
email, phoneכתובת דוא״ל תקינה ליצירת קשר, עד 100 תווים, ומספר טלפון בפורמט בינלאומי עם קידומת מדינה +, עד 20 תווים. שמרו על עקביות בפרטי העסק לאורך הרישום.
companyName, ein, einIssuingCountryעבור ארגונים, ספקו את השם החוקי של החברה ואת מזהה המס העסקי. מדינת ההנפקה של המזהה היא שדה נפרד בן שתי אותיות. מגבלות: companyName 255 ו-ein 21 תווים. עוסק יחיד משתמש בשדות שם אישי במקום בזהות המס של ארגון.
brandRelationship, verticalהקשר לעסק והענף שלו, תוך שימוש בקודי קטלוג עדכניים. ארגונים נדרשים לספק אותם; הכללים לעוסק יחיד שונים. אל תחליפו קודי API בתוויות תצוגה מתורגמות.
firstName, lastName, mobilePhoneנדרש עבור עוסק יחיד. שדות השם מאפשרים עד 100 תווים כל אחד. ספקו מספר נייד כשיר עבור אימות OTP הנדרש, בפורמט בינלאומי.
stockSymbol, stockExchange, website, businessContactEmailחברה ציבורית זקוקה גם לסמל נייר ערך/בורסה שלה, ל-website ולכתובת דוא״ל עסקית כשירה ליצירת קשר עבור תהליך האימות הנוסף. מגבלות: stockSymbol 10, website 255 ו-businessContactEmail 255 תווים.
altBusinessIdType, altBusinessIdמזהה עסקי חלופי אופציונלי. ספקו את הסוג ואת הערך יחד. השתמשו בקטלוג הסוגים העדכני; הערך מאפשר עד 50 תווים.
referenceIdאסמכתא עסקית שלכם, עד 50 תווים. כללו אותה עבור רישום עוסק יחיד בהתאם לדרישות העדכניות הספציפיות לישות. זהו מטא-נתונים עסקיים, לא מפתח האידמפוטנטיות של הבקשה.
website, ipAddress, tagערכי אתר נוסף, מטא-נתונים של IP מקור ותיוג כאשר רלוונטי. אלה אינם מבססים בעלות על החשבון ואינם מחליפים בדיקות זהות.
mockערך בוליאני של JSON. השתמשו ב-true רק עבור התהליך המדומה המיועד; השתמשו ב-false עבור רישום ייצור שנבדק במפורש. אל תשלחו את המחרוזת "false" כתחליף לערך בוליאני של JSON.

עוסקים יחידים נתמכים עבור רישומים של ארה״ב או קנדה ונדרשים לאימות OTP לפני זכאות לקמפיין. חברות ציבוריות עשויות לדרוש שלב אימות של איש קשר עסקי. GOVERNMENT מיועד לישויות ממשלתיות שבסיסן בארה״ב; ודאו את קטגוריית הישות הנכונה עבור ארגונים אחרים. פעלו לפי הדרישות הספציפיות לישות וכן לפי שגיאות האימות שהוחזרו.

שמרו על מפתח אידמפוטנטיות יציב

צרו Idempotency-Key אחד עבור רישום מיועד זה. הוא חייב להכיל 1–128 תווי ASCII להדפסה ללא רווחים. השתמשו שוב באותו מפתח רק עם אותה שיטת HTTP, נתיב, מחרוזת שאילתה ובתי גוף בקשה מדויקים. עיצוב מחדש של JSON, גם ללא שינוי משמעותו, משנה את טביעת הבקשה.

בקשה עם מפתח שהושלמה יכולה להשמיע שוב את התגובה השמורה שלה ללא הגשת רישום נוספת. כפילות שעדיין מעובדת מחזירה HTTP 409 ועשויה לכלול Retry-After. בקשה ששונתה עם אותו מפתח מתנגשת. אל תצרו מפתח חדש רק משום שבקשה פג תוקפה או החזירה שגיאה: ייתכן שהעסק כבר נרשם.

שמרו את brand.json ללא שינוי במהלך הטיפול בבקשה זו. תגובה שמורה של 500 או 502 עלולה להשמיע שוב את השגיאה המקורית במקום לנסות שוב את הרישום. שמרו כל brandId, requestId וכותרות מתאם שהוחזרו; בדקו את מצב המותג הקיים בפועל ויישבו אי-התאמות לפני תחילת בקשה אחרת.

קראו את המותג ואת מצבו

API זה משתמש בקודי מצב HTTP ובגוף JSON ישיר, ולא במעטפת status/response של v3. רישום מוצלח מחזיר אובייקט מותג הכולל brandId. אחסנו מזהה זה ובדקו את מצב האימות או הזהות שהוחזר. שדות נוספים תלויים בישות ובמצב הרישום.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID"

קראו רק מותג השייך לחשבון שלכם. 404 יכול לומר שהמותג אינו זמין לחשבון זה. השלימו כל אימות נדרש, ואז השתמשו בהסמכת מותג כדי למצוא את מקרי השימוש הזמינים שלו לקמפיין. אין להניח שמשאבים מדומים זכאים לשליחה בייצור.

עמלות ייצור

עמלות רישום מותג מוגדרות עדכניות
רישוםעמלה
ארגון רגיל$5.00
עוסק יחיד$4.45
מותג מדומהאין חיוב רישום מותג בתהליך המדומה

סכומים קמעונאיים אלה נבדקו מול תצורת הפורטל העדכנית ב-24 באוקטובר 2026. ודאו את העמלה העדכנית בפורטל לפני רישום ייצור. חיובי קמפיין, בדיקות נוספות ושימוש בהודעות הם נפרדים. רישום ייצור בודק הרשאת רכישה ומימון זמין לפני ההגשה; יצירה מוצלחת של המותג במרשם וחיוב מקומי הם שלבי עיבוד נפרדים, לכן שמרו את מזהה המשאב ובצעו התאמת עסקאות אם מתרחשת שגיאה או בעיית חיוב.

שינוי מותג מדומה לייצור הוא תהליך המאושר בנפרד ועלול ליצור זהות ייצור וחיוב חדשים. אל תניחו שעריכת mock ל-false בבקשה מאוחרת יותר ממירה את המותג הקיים.

טפלו בשגיאות מבלי לשכפל את המותג

כשלי רישום
תוצאת HTTPמה לבדוק
400קראו את שגיאות השדה. שגיאות אימות של הרשם יכולות להיות מערך של אובייקטים מסוג code/description. אימות מפתח אידמפוטנטיות מקומי יכול גם להחזיר 400.
401, 403 או 404בדקו אישורי API, את כתובת ה-IP המותרת של מקור הבקשה עבור חשבון ה-API, הרשאות לקוח ובעלות. תגובת המרשם יכולה גם לשאת שגיאת הרשאה משלה.
402בדקו מימון והרשאת רכישה. אל תתייחסו לבקשת ייצור לא ממומנת כאל בדיקת ארגז חול.
409שמרו על אותו מפתח ובקשה ללא שינוי בזמן המתנה לבקשה בתהליך. במקרה של התנגשות עקב שינוי בגוף הבקשה או במפתח, או של תגובה קודמת שלא ניתן לשחזר, יש לבדוק תחילה את מצב הבקשה בפועל וליישב אי-התאמות.
429 או תגובת מגביל לא זמיןכבדו את Retry-After כאשר הוא קיים. נסו שוב את אותה בקשה מיועדת ואת המפתח לאחר שהמגבלה מתפנה.
500 או 502ייתכן שהפעולה המרוחקת התקבלה. שגיאת עיבוד מקומית יכולה לכלול requestId. שמרו אותו ובדקו את המשאב הקיים; אל תניחו שנדרש רישום חלופי.