Присвояване на номер към кампания за съобщения

Присвояване на номер за изпращане към кампания

Използвайте тази операция, след като вашата марка за съобщения и производствената кампания са регистрирани и кампанията е активна. Тя свързва един номер с активиран SMS от вашия акаунт с кампанията. Тя не създава марка, не създава или одобрява кампания, не купува номер и не изпраща съобщение.

Текущият портал използва този маршрут при присвояване на кампания към номер. Публичният API приема идентификатор на кампания; той извлича марката от кампанията, притежавана от акаунта, вместо да приема отделен идентификатор на марка.

Заявка

Изпратете POST заявка с form-encoded кодиране през HTTPS, като използвате активирания си API акаунт и разрешения за него IP адрес на източника. Използвайте действителните идентификатори на номер и кампания от вашия акаунт. Номерът в този пример е измислен.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=add' \
  --data-urlencode "campaign=$CAMPAIGN_ID" \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

Параметри за присвояване на кампания
Параметър	Задължителен	Значение
action	Да	Използвайте add, за да присвоите, или delete, за да премахнете текущото свързване на номера с кампания. Регистърът на буквите и околните интервали се нормализират.
campaign	За add	campaignId на ACTIVE кампания, притежавана от удостоверения акаунт. Нейната марка също трябва да принадлежи на акаунта. Кампания, изрично маркирана като sandbox, не може да бъде присвоена към реални номера за изпращане. Пропуснете този параметър за delete; премахването използва съществуващото свързване на номера.
number	Да	Притежаваният, активен, неанулиран номер за изпращане с активиран SMS. За северноамерикански номер използвайте код на държава 1, последван от десетте му цифри, без знак плюс. Обработчикът премахва нецифровите знаци и също така търси еквиваленти с префикс плюс и с десет цифри. Тази нормализация не е обща проверка за валидност на телефонния номер.

Операцията променя един номер. Тя няма пагинация, параметър за пакетна обработка или опция за пробно изпълнение. Не използвайте крайна точка за създаване на кампания само за да прикачите номер към съществуваща кампания.

Премахване на текущото свързване

Използвайте action=delete с притежавания номер. Това премахва свързването му с кампания за изпращане и изчиства запазените полета за марка/кампания за този номер. То не изтрива кампанията или марката, не освобождава телефонния номер, не прекратява услугата на номера и не спира периодичното таксуване на кампанията.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=delete' \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

Отговор и проверка

Този измислен пример илюстрира обичайния обвиващ API отговор и избрани полета от резултата. Върнатият номер запазва формата, съхранен във вашия акаунт. brandId и campaignId са празни низове след успешно премахване.

{
  "status": {"code": 200, "msg": "Campaign assignment updated."},
  "response": {
    "number": "+12025550123",
    "brandId": "BRAND_FROM_ACCOUNT",
    "campaignId": "CAMPAIGN_FROM_ACCOUNT",
    "providerStatus": 200
  }
}

providerStatus е HTTP статусът на партньора за съобщения. Обработчикът приема транспортен отговор 2xx и след това актуализира локалния запис на номера; той не интерпретира тялото на отговора на партньора за отделен резултат за приемане на бизнес ниво. Следователно успешният отговор не е доказателство, че регистрацията за съобщения е завършена или че доставката ще успее. Прегледайте статуса на кампанията на номера в портала, преди да изпращате производствен трафик.

Не разглеждайте само локалното свързване като одобрение за доставка. Одобрението на кампанията и марката, предоставянето на номера, разрешенията на акаунта, правилата за съдържание и обичайните ограничения за съобщения продължават да важат.

Грешки и частични резултати

401: обработчикът не разполага с удостоверен акаунт.
400: action или number липсва/е невалиден, или заявка add няма идентификатор на кампания.
404: номерът не е притежаван, активен, неанулиран SMS номер.
409: кампанията е недостъпна за акаунта, не е ACTIVE, е изрично sandbox или нейната марка е недостъпна за акаунта.
503: интеграцията за съобщения е недостъпна. Свържете се с поддръжката, вместо да променяте идентификационните данни на акаунта или да измисляте конфигурационни стойности.
502: заявката за съобщения е неуспешна, изтекла е по време или е върнала HTTP статус, различен от 2xx. Може да бъде върнат providerStatus. Изтичането на времето не доказва, че партньорът не е направил промяна.
500 с partial=true: партньорът за съобщения е върнал успешен HTTP статус, но локалното свързване не можа да бъде потвърдено. Съгласувайте номера в портала или се свържете с поддръжката, преди да опитате отново.

Проверявайте кода на API статуса и тялото на отговора, както и HTTP резултата. Не повтаряйте сляпо заявка след изтичане на времето или частичен резултат. Този обработчик няма ключ за идемпотентност на ниво заявка, транзакционно връщане назад или проверка за завършване на регистрацията на кампанията. Повторно съвпадащо локално присвояване може да върне успех дори когато базата данни не отчита променени редове.

Обхват и ефекти

Тази операция променя маршрутизирането на номера за изпращане и запазеното му свързване с кампания/марка. В прегледания обработчик тя не съдържа директно дебитиране на акаунта, създаване на кампания, покупка или изпращане на съобщение. Това не е ценова оферта или обещание за безплатна услуга: съществуващите такси за номер, кампания и съобщения продължават съгласно условията на вашия акаунт.

В портала смяната към друга кампания първо премахва предишното свързване и след това добавя новото. Това са отделни заявки. Ако втората заявка е неуспешна, по-ранното свързване може вече да е премахнато. Не предполагайте, че двете заявки се връщат назад заедно.