Yeni SMS Paylaşımı Oluşturma

Yeni bir SMS paylaşımı oluşturur.

POST /v1/sms_campaigns/{campaign_id}/sms_sharings

Kimlik Doğrulama

Kimlik Doğrulama Yöntemi Token token=<API_TOKEN>

İstek

Yol Parametreleri

Parametre	Tip	Zorunlu	Açıklama	Örnek
`campaign_id`	string (uuid)	Evet	Kampanya ID'si.	`campaign_id`

Header Bilgileri

Header	Zorunlu	Açıklama	Örnek
`Content-Type`	Evet	İstek içeriğinin türü.	`application/json`
`Authorization`	Evet	Pisano API token'ı.	`Token token=<API_TOKEN>`

İstek Gövdesi

{
  "phone_numbers": [
    "<phone_number>"
  ],
  "custom_attributes": {
    "<phone_number>": {
      "name": "<name>",
      "external_id": "<external_id>",
      "email": "<email>"
    }
  },
  "built_in_responses": {
    "<phone_number>": {
      "customerDetailInfo1": "<customerDetailInfo1>",
      "customerDetailInfo2": "<customerDetailInfo2>"
    }
  }
}

İstek Gövdesi Alanları

Alan	Tip	Zorunlu	Açıklama
`phone_numbers`	array	Evet	Telefon numaraları.
`phone_numbers[]`	string		Telefon numarası.
`custom_attributes`	object	Hayır	Özel nitelikler.
`custom_attributes.<phone>.name`	string		Müşterinin adı.
`custom_attributes.<phone>.external_id`	string		Müşterinin harici tanımlayıcısı.
`custom_attributes.<phone>.email`	string		Müşterinin e-posta adresi.
`built_in_responses`	object	Hayır	Yerleşik yanıtlar.
`built_in_responses.<phone>.customerDetailInfo1`	string		Yerleşik yanıt değeri.
`built_in_responses.<phone>.customerDetailInfo2`	string		Yerleşik yanıt değeri.

İstek Örneği

cURL

cURL İstek Örneği

curl --location 'https://<pisanoEnvironment>/v1/sms_campaigns/<campaignID>/sms_sharings' \
--header 'Authorization: Token token=<API_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
  "phone_numbers": [
    "<phone_number>"
  ],
  "custom_attributes": {
    "<phone_number>": {
      "name": "<name>",
      "external_id": "<external_id>",
      "email": "<email>"
    }
  },
  "built_in_responses": {
    "<phone_number>": {
      "customerDetailInfo1": "<customerDetailInfo1>",
      "customerDetailInfo2": "<customerDetailInfo2>"
    }
  }
}'

Yanıtlar

200 Başarılı

İşlem başarılı.

Yanıt Alanları

Alan	Tip	Açıklama
`status`	string	SMS paylaşımı isteği için döndürülen işlem durumu.
`delivery_time`	string	İstek için döndürülen teslimat zamanı.
`sidekiq_job_id`	string	Arka plan görevinin tanımlayıcısı.
`correlation_id`	string	İsteği izlemek ve diğer ilişkili isteklerle eşleştirmek için kullanılan tanımlayıcı.

Yanıt Örneği

JSON Yanıt Örneği

{
  "status": "enqueued",
  "delivery_time": "<delivery_time>",
  "sidekiq_job_id": "<sidekiq_job_id>",
  "correlation_id": "<correlation_id>"
}

400 Hatalı İstek

Bir hata oluştu.

Hata Kodu: 13000
Hata Mesajı: Bir hata oluştu.

{"error_message":"An error occured","data":"An error occured","code":13000}

401 Yetkisiz Erişim

Hatalı kimlik doğrulama anahtarı.

Hata Kodu: 13001
Hata Mesajı: Hatalı kimlik doğrulama anahtarı.

{"error_message":"Wrong authentication token","data":"Wrong authentication token","code":13001,"errors":null}

403 Erişim Engellendi

İzin reddedildi.

Hata Kodu: 13013
Hata Mesajı: İzin reddedildi.

{"error_message":"Permission denied","data":"Permission denied","code":13013,"errors":null}

404 İstenen kaynak bulunamadı!

Ek Bilgiler

İstek Sınırları	5 saniyede 20 istek; 25 saniyede 40 istek; 125 saniyede 80 istek; 625 saniyede 160 istek. On-premise ortamlarındaki istek sınırı kuralları ayarlanabilir veya kaldırılabilir.
Kullanım Kısıtlamaları	En iyi uygulama olarak tek bir istekte en fazla 5.000 müşteri için tetikleme yapılması önerilir.

Pisano Kampanya Paylaşım API'leri - SMS - SMS Paylaşımı