นักพัฒนา

POST/tcr/v2/brand/nonBlocking

ลงทะเบียนแบรนด์ข้อความ

ลงทะเบียนข้อมูลประจำตัวธุรกิจที่เป็นของบัญชี ระบุคำขอแซนด์บ็อกซ์ให้ชัดเจน และกระทบยอดการตรวจสอบความถูกต้องกับค่าธรรมเนียม

ในหน้านี้
  1. ลงทะเบียนธุรกิจที่อยู่เบื้องหลังข้อความของคุณ
  2. เริ่มต้นด้วยคำขอแซนด์บ็อกซ์ที่ชัดเจน
  3. ฟิลด์ธุรกิจและผู้ติดต่อ
  4. เก็บคีย์ป้องกันการส่งซ้ำให้คงที่
  5. อ่านแบรนด์และสถานะของแบรนด์
  6. ค่าธรรมเนียมการใช้งานจริง
  7. จัดการข้อผิดพลาดโดยไม่ทำให้แบรนด์ซ้ำซ้อน

ลงทะเบียนธุรกิจที่อยู่เบื้องหลังข้อความของคุณ

แบรนด์ข้อความระบุธุรกิจที่ส่งข้อความ US 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ที่อยู่ธุรกิจจริง ใช้รหัสประเทศสองตัวอักษรและรหัส US 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

ผู้ประกอบการรายเดี่ยวได้รับการรองรับสำหรับการลงทะเบียนใน US หรือแคนาดา และต้องยืนยัน OTP ก่อนจึงจะมีสิทธิ์ได้รับแคมเปญ บริษัทมหาชนอาจต้องมีขั้นตอนการตรวจสอบอีเมลติดต่อธุรกิจ GOVERNMENT สำหรับหน่วยงานภาครัฐที่อยู่ใน US โปรดยืนยันหมวดหมู่ธุรกิจที่ถูกต้องสำหรับองค์กรอื่น ปฏิบัติตามข้อกำหนดเฉพาะของแต่ละประเภทธุรกิจรวมถึงข้อผิดพลาดการตรวจสอบที่ส่งคืนมา

เก็บคีย์ป้องกันการส่งซ้ำให้คงที่

สร้าง Idempotency-Key หนึ่งค่าสำหรับการลงทะเบียนตามที่ตั้งใจนี้ คีย์ต้องประกอบด้วยอักขระ ASCII ที่พิมพ์ได้โดยไม่มีช่องว่างจำนวน 1–128 ตัว ใช้อ้างอิงคีย์เดิมซ้ำเฉพาะกับเมธอด HTTP พาธ สตริงข้อความค้น และไบต์ของเนื้อความคำขอที่เหมือนกันทุกประการเท่านั้น การจัดรูปแบบ JSON ใหม่ แม้ไม่เปลี่ยนความหมาย จะเปลี่ยนลายนิ้วมือของคำขอ

คำขอที่มีคีย์ซึ่งเสร็จสมบูรณ์แล้วสามารถเล่นการตอบกลับที่จัดเก็บไว้ซ้ำได้โดยไม่ต้องส่งการลงทะเบียนอีก คำขอซ้ำที่ยังอยู่ระหว่างการประมวลผลจะส่งคืน HTTP 409 และอาจมี Retry-After รวมอยู่ด้วย คำขอที่เปลี่ยนแปลงแล้วแต่ใช้คีย์เดิมจะขัดแย้งกัน ห้ามสร้างคีย์ใหม่เพียงเพราะคำขอหมดเวลาหรือส่งคืนข้อผิดพลาด ธุรกิจนั้นอาจได้รับการลงทะเบียนแล้ว

เก็บ brand.json ไว้โดยไม่เปลี่ยนแปลงขณะดำเนินการคำขอนั้น ข้อผิดพลาด 500 หรือ 502 ที่แคชไว้อาจเล่นข้อผิดพลาดเดิมซ้ำแทนที่จะลองลงทะเบียนอีกครั้ง เก็บ brandId, requestId ที่ส่งคืนมาและส่วนหัวความสัมพันธ์ไว้ ตรวจสอบสถานะจริงของแบรนด์ที่มีอยู่และแก้ไขความคลาดเคลื่อนก่อนเริ่มคำขออื่น

อ่านแบรนด์และสถานะของแบรนด์

API นี้ใช้รหัสสถานะ HTTP และเนื้อความ JSON โดยตรง แทนที่จะเป็นซอง v3 status/response การลงทะเบียนที่สำเร็จจะส่งคืนออบเจ็กต์แบรนด์ที่มี 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 รวมอยู่ด้วย โปรดบันทึกค่าไว้และตรวจสอบทรัพยากรที่มีอยู่ ห้ามสันนิษฐานว่าจำเป็นต้องลงทะเบียนทดแทน