Metin İsteği

Metin İsteği, müşteri katılımını ateşlemeyi sağlamak için oluşturulmuş bir iş metin oluşturma platformudur. Günlük iletişim sorunlarınız için bir tak çalıştır mesajlaşma çözümü oluşturduk, böylece gürültüyü kesebilir ve istediğiniz zaman, her yerde müşterilerle bağlantı kurabilirsiniz. Sizin gibi meşgul iş liderlerine nasıl yardımcı olduğumuz hakkında daha fazla bilgi edinin.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet	Class	Bölgeler
Copilot Studio	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)
Logic Apps	Standart	Aşağıdakiler dışında tüm Logic Apps bölgeleri :      - Azure Kamu bölgeleri      - Azure Çin bölgeleri      - ABD Savunma Bakanlığı (DoD)
Power Apps	Premium	Aşağıdakiler dışında tüm Power Apps bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)
Power Automate	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)

İletişim
İsim	Metin İsteği API Desteği
URL	https://www.textrequest.com/contact
E-posta	apidev@textrequest.com

Bağlayıcı Meta Verileri
Publisher	Metin İsteği
Web sitesi	https://www.textrequest.com/
Gizlilik ilkesi	https://www.textrequest.com/privacy-policy/
Kategoriler	İletişim; Satış ve CRM

Aranda Service Management Suite (ASMS)

İş süreçlerini ve hizmetlerini yönetmenize, tümleştirmenize ve otomatikleştirmenize olanak tanıyan çok kiracılı bir çözüm olan Aranda Service Management Suite ile şirketinizin üretkenliğini artırın ve kullanıcılarınızın deneyimini dönüştürün. Olaylar, gereksinimler ve değişiklikler dahil olmak üzere ASMS'nin herhangi bir çalışma alanında (proje) depolanan kayıtları oluşturun, arayın ve güncelleştirin.

Pre-requisites

Devam etmek için aşağıdaki önkoşulları göz önünde bulundurun:

• Bir abonelik ve Aranda Service Management Suite (ASMS) örneği. Buradan başlayın: https://arandasoft.com/
• Premium bağlayıcı özelliklerine sahip etkin bir Microsoft Power Automate aboneliği.

Kimlik Bilgilerini Alma

• Kimlik doğrulaması gerçekleştirmek için tümleştirme belirtecini kullanın. Aşağıdaki bağlantıda tümleştirme belirtecinin nasıl alınacağı hakkında bilgi bulabilirsiniz

Bağlayıcınızı kullanmaya başlama

1. Aranda Service Management Suite (ASMS) aboneliği gerektirir.

2. Tümleştirme belirtecini alma

3. Aranda Hizmet Yönetimi ASMS API'sinin (ApiAsms) Örnek URL'sini alın.

4. Aranda Service Management Suite bağlayıcısı ile bağlantı kurun.

5. Bağlayıcı tarafından sunulan aşağıdaki işlevlerden birini seçin:

6. Bağlayıcıyla ilgili ayrıntılı belgeler için bkz. https://docs.arandasoft.com/connectors

Bu bağlayıcıyı aşağıdaki durumlarda kullanabilirsiniz:

1. Kullanılabilir diğer eylemlerle birlikte biletler oluşturun, arayın ve güncelleştirin.
2. Bilet izlenebilirliği elde edin.
3. Biletle ilgili ekleri indirin.
4. Aranda Service Management Suite'te bilgi bankası (KB) makalelerini arayın.
5. Bilgi bankası (KB) makalelerinden ekleri indirin.
6. Yapılandırma öğelerini (CI) oluşturma, arama ve güncelleştirme.
7. Kuruluşların iç destek isteklerini çözümlemesine, teknik sorun çözme sürecini yönetmesine ve kolaylaştırmasına olanak tanır.
8. İstekte bulunanlar ve destek aracıları arasındaki iletişimlerin izlenmesine izin verir.
9. İstek sahiplerine biletinin durumunu bildirmek için otomatik yanıtlar sunun.

Başarılı yanıt

Kod	İsim	Description
200	Tamam	İstek başarılı oldu
204	İçerik Yok	İstekte veri bulunamadı

Yaygın hatalar ve çözümler

Kod	İsim	Description	Çözüm
400	Hatalı İstek	CriteriaNeedsSomeArguments	Arama parametrelerinin boş olup olmadığını denetleyin
400	Hatalı İstek	InvalidAdditionalFieldId	Ek alanların kimliklerinin doğru olup olmadığını denetleyin
400	Hatalı İstek	InvalidItemType	Servis talebi türü yanlış, servis talebi türü kimliğini değiştirin
400	Hatalı İstek	InvalidProjectId	Proje kimliği yanlış, servis talebini ilişkilendirebileceğiniz proje kimliğini değiştirin
400	Hatalı İstek	InvalidStateId	Bilet oluştururken veya güncelleştirirken eklenen durumu denetleme
400	Hatalı İstek	InvalidUploadType	Bir dosya eklenirken bir hata oluştu, Sistem Yöneticisi'nden yardım isteyin
400	Hatalı İstek	RequestNeedsSomeArguments	Biletin gerekli alanlarını denetleyin ve bunların karşılık gelen değerini bağlayıcıya ekleyin
400	Hatalı İstek	SearchListIsRequired	Sistem Yöneticisi'nden yardım isteme
400	Hatalı İstek	Parametre Adı: {Name parameter}	Hatada belirtilen özelliklerin null olup olmadığını denetleyin
400	Hatalı İstek	Null parametre adı: {Name parameter}	Hatada belirtilen özelliklerin null olup olmadığını denetleyin
400	Hatalı İstek	ItemTypeIsRequired	Büyük/küçük harf türü ekleme
400	Hatalı İstek	ModelIdIsEmpty	modelId parametresini ekleyin. Bu gereklidir.
400	Hatalı İstek	StateIdIsEmpty	stateId parametresini ekleyin. Bu gereklidir.
400	Hatalı İstek	ServiceIdIsEmpty	serviceId parametresini ekleyin. Bu gereklidir.
400	Hatalı İstek	CategoryIdIsEmpty	categoryId parametresini ekleyin. Bu gereklidir.
400	Hatalı İstek	TypesListNeedsSomeArguments	Bilet ararken servis talebi türünün eklenmesini gerektirir, Sistem Yöneticisinden yardım isteyin
400	Hatalı İstek	'{PARAMETER_NAME}' AdditionalFieldIsRequired	'{PARAMETER_NAME}' ek alanı zorunlu
400	Hatalı İstek	ModelNotActive	Servis talebiyle ilişkilendirilmiş model etkin değil
400	Hatalı İstek	FailedToCloseTaskPendingCloseTasksPredecessors	Servis talebini kapatmaya çalışırsanız ve üst servis talebinin kapatılmayı bekleyen görevleri varsa
400	Hatalı İstek	DuplicatedObject	Ci veritabanında zaten var
400	Hatalı İstek	EmptyValue Parametre adı: {PARAMETER_NAME}	{PARAMETER_NAME} parametresi gerekiyor
400	Hatalı İstek	EmptyEnumeration Parametre adı: {PARAMETER_NAME}	{PARAMETER_NAME} parametresi bir listedir ve gereklidir
403	Yasak	DoNotHavePermissionForThisAction	İzinleri atamak için Sistem Yöneticinizle görüşün

Kod	İsim	Description	Çözüm
beş yüz	İç Sunucu Hatası		Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureExportExcel	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetAdditionalFields	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetCategoriesByService	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetChangeFSC	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetFields	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetFieldsList	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetFiles	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetLookupValues	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetMailTemplates	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetModelByCategory	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetOperators	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetReassignmentReasons	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureGetSimilarItems	Sistem Yöneticisi'nden yardım isteme
beş yüz	İç Sunucu Hatası	FailureSearchQuickManagement	Sistem Yöneticisi'nden yardım isteme

FAQ

1. Bağlayıcıdaki farklı eylemleri (örneğin, proje, hizmet, kategori, grup, uzman) kullanmak için gereken özniteliklerin kimlikleri nasıl alınır?

   Kimlikler birçok yolla alınabilir:

   • Aranda Sorgu Yöneticisi'ni kullanarak, gerekli verilerin bulunduğu Aranda Service Management Suite (ASMS) tablosunu sorgulayan bir rapor oluşturabilirsiniz. Çözümdeki veri nesneleriyle ilgili yardıma ihtiyacınız varsa aşağıdaki bağlantıyı https://docs.arandasoft.com/docs/database.html ziyaret edin ve ASMS yüklemenize karşılık gelen Aranda veritabanı sürümünü belirleyin.
   • ASMS Şirket İçi yükleme kullanıyorsanız, gerekli verilerin bulunduğu ASMS tablosunu bir SQL istemcisi aracılığıyla sorgulayabilirsiniz.
   • Aranda Destek Merkezi aracılığıyla, aşağıdaki web sitesinde belirtilen iletişim kanalları aracılığıyla bir destek isteği oluşturun Destek.

2. "Ek Ekle" eylemi kullanılırken eklenecek dosyaların boyutu üst sınırı nedir?

   Maksimum boyut, ASMS örneğinizin/yüklemenizin belirli yapılandırmasına bağlıdır. Lütfen ASMS Yöneticinize sorun.

3. Bağlayıcının gerektirdiği ASMS bağlantısının yapılandırmasında belirteci kullanılan teknisyen hesabının gerektirdiği veri erişim düzeyi nedir?

   Erişim düzeyi, ASMS'de düzenli olarak kullanılan teknisyen hesabıyla aynıdır. Başka bir deyişle, ASMS'deki ilgili teknisyenin rollerine ve izinlerine bağlı olarak verilere bağlayıcı ile erişilebilir.

4. Bağlayıcıda belirteci kullanılacak teknisyen hesabı Adlandırılmış mı yoksa Eşzamanlı mı olmalıdır?

   Bağlayıcı, ilgili ASMS örneğine saatte birden çok kez erişebildiğinden hesabın Adlandırılmış tür olması kesinlikle önerilir.

5. Bağlayıcı kullanılarak servis taleplerinin oluşturulması veya değiştirilmesi, ASMS arabiriminde bulunan veri doğrulama kurallarına uyuyor mu?

   Evet, aynı doğrulama kurallarını izler. Örneğin, belirli bir proje, hizmet ve kategori için servis talebi oluştururken yerel ve ek alanların doldurulması gerekiyorsa, bağlayıcı aracılığıyla servis talebi gönderilirken de bu veriler gerekir.

6. Bağlayıcı Bulut ve Şirket İçi ortamlarındaki ASMS örnekleri için kullanılabilir mi?

   Evet, ASMS'nin hem Bulut hem de Şirket İçi yüklemelerinde kullanılabilir. Şirket İçi yüklemelerde ASMS sunucusu ile Power Automate ortamınız arasındaki bağlantıyı göz önünde bulundurmanız gerekir.

7. Yalnızca Standart bağlayıcıları kullanmama izin veren bir Power Automate lisansım var. ASMS bağlayıcısını kullanabilir miyim?

   Mümkün değildir, ASMS bağlayıcısı Premium türdür.

8. Power Automate'te ASMS'deki olaylardan (örn. bir servis talebi oluşturulduğunda, belirli bir gruba servis talebi atandığında) başlayan akışlar oluşturmak istiyorum. ASMS'de gerçekleşen olaylardan başlayan Tetikleyicileri kullanmak mümkün mü?

   Evet, mümkün. Aşağıdaki adımlar önerilir:

   • "HTTP isteği alındığında" tetikleyicisini başlatın ve ASMS'den alınması beklenen veri yapısını içeren bir İstek Gövdesi JSON Şeması oluşturun. Tetikleyici oluşturulduktan sonra ASMS örneğinizde kullanmak üzere bir HTTP POST URL'si (Web Kancası URL'si) alırsınız. Web Kancası URL'sine (örneğin Belirteç) erişmek için kimlik doğrulama mekanizmasını göz önünde bulundurmayı unutmayın.
   • Karşılandığında akışı Power Automate'te başlatması gereken koşullar kümesi için ASMS'de bir iş kuralı oluşturun. Kural içinde bir eylem olarak "Web Kancasını Çağır" öğesini seçin ve çağırma hedefi URL'sine daha önce elde edilen Web Kancası URL'sini, gönderilecek parametreleri ve isteğin gövdesini (İstek Gövdesi JSON Şemasıyla eşleşmesi gerekir) girin. ASMS'de bir kuraldan Web kancası çağırma hakkında daha fazla bilgi için şu bağlantıyı ziyaret edin: Web kancası kuralı
   • Oluşturulan kuralı test edin ve Web Kancası URL'sine bir HTTP isteğinin gönderildiğini doğrulayın ve akışı Power Automate'te başlatır.

9. ASMS REST API uç noktalarını Power Automate'teki akışlardan eylem olarak çağırabilir miyim?

   Evet, mümkün. "HTTP" eylemini kullanın ve içindeki gerekli verileri doldurun (URI, Yöntem, Üst Bilgiler, Gövde, diğerleri arasında).

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:

Varsayılan	Bağlantı oluşturmak için parametreler.	Tüm bölgeler	Paylaşılamaz

Temerrüt

Geçerli: Tüm bölgeler

Bağlantı oluşturmak için parametreler.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim	Türü	Description	Gerekli
API Anahtarı	securestring	Bu API için API Anahtarı	Doğru

Azaltma Sınırları

Name	Çağrılar	Yenileme Dönemi
Bağlantı başına API çağrıları	100	60 saniye

Eylemler

Belirli bir panonun adını güncelleştirme	Panoyu güncelleştirir. Bu, panonun telefon numarasını değiştirmez. Başka bir panonun kişileriyle yeni bir numara istiyorsanız, POST içeren yeni bir pano oluşturmanız ve toplu dışarı/içeri aktarma işlemiyle kişileri eklemeniz gerekir.
Belirtilen filtreleme ölçütüyle eşleşen tüm kişileri alma	Belirtilen filtreleme ölçütüyle eşleşen tüm kişileri alır. Yalnızca belirtilen pano aranacak; kullanılabilir bir sayı için hesap düzeyinde arama yoktur.
Belirtilen kimlikle grubu siler	Belirtilen kimlikle grubu siler. Bu, grubun üyesi olan kişiler olsa bile başarılı olur (kişiler silinmez).
Belirtilen kimlikle ödemeyi alır	Belirtilen kimlikle ödemeyi alır.
Belirtilen panoyu siler	Belirtilen panoyu siler.
Belirtilen telefon numarasına sahip kişiyi alır	Belirtilen telefon numarasına sahip kişiyi alır
Belirtilen telefon numarasına sahip kişiyi siler	Belirtilen telefon numarasına sahip kişiyi siler
Belirtilen ödemeyi iptal eder	Belirtilen ödemeyi iptal eder ve kullanıcıya ödemenin iptal edildiğini iletir. Ödemeler düzenlenemez, bu nedenle yeni bir ödemeyi iptal etmek ve vermek, bir ödemeyi düzeltmenin en iyi yoludur.
Bir grubu kimliğine göre alma	Belirtilen kimlikle grubu alır.
Bir kişinin telefon numarasına göre konuşmanın iletilerini alma	Belirtilen pano ve telefon numarası arasındaki konuşmayı alın.
Bu pano hakkında bilgi edinin	Panonun adını ve telefonunu döndürür.
Bu pano için tüm konuşmaları alır	Bu pano için tüm konuşmaları alır ve her konuşmanın son iletisiyle ilgili bilgileri içerir.
Hesaptaki tüm panoları alma	Bir hesaptaki tüm panoları alır.
Kişi oluşturma veya güncelleştirme	Bir kişiyi oluşturur veya güncelleştirir (verilen telefon numarasıyla zaten var olup olmadığına bağlı olarak).
Kişileri toplu güncelleştirme	Yalnızca belirtilen panoda kişiler eklenir; kişiler panoya göre düzenlenir ve kullanılabilir bir sayı için hesap düzeyinde arama yoktur.
Konuşmayı Arşivle	Bir konuşmayı arşivler ve tüm konuşma alma uç noktalarının sonuçlarından kaldırır. Müşteri Metin İsteği numaranıza metin gönderirse veya müşteriye Metin İsteği numaranızdan bir metin gönderirseniz konuşma otomatik olarak arşivlenir. Konuşmaları arşivleme, gelecekte konuşmayı planlamadığınız müşterilerden dağınıklığı ortadan kaldırmanın iyi bir yoludur. Bir müşteri daha fazla SMS mesajı göndermenizi önlemek için "DUR" iletisi gönderirse konuşmanın otomatik olarak arşivlendiğini unutmayın.
Konuşmayı Arşivleme	Bir konuşmayı arşivler. Bir konuşma arşivlenmemiş durumda olduğunda, bir kez daha kuyrukta görünür. ayrıca /conversations uç noktası tarafından döndürülen konuşmalarda da görünür. Bir konuşma zaten arşivlenmemişse, bu yöntemin hiçbir etkisi yoktur.
Kullanıcıya belirtilen ödemeyi ödemesini anımsatan bir izleme metni gönderin	Belirtilen ödemeyi ödemek için kişiye bir anımsatıcı gönderir. İletinin içeriği otomatik olarak oluşturulur. İstenmeyen postaları önlemek için ödeme başına yalnızca bir anımsatıcı gönderilebilir
Tüm etiketleri alır	Bu panonun tüm etiketlerini alır. Etiketler panolar arasında benzersizdir.
Tüm grupları alır	Kullanıcının hesabı için tüm grupları alır.
Tüm ödemeleri alır	İptal edilen ve ödenen ödemeler de dahil olmak üzere tüm ödemeleri alır. Bunlar sorgu parametreleri kullanılarak filtrelenebilir.
Tüm özel alanları alır	Bu pano için tüm özel alanları alır. Özel alanlar panolar arasında benzersizdir.
Verilen ad ve telefon numarasıyla yeni bir pano oluşturma	Hesapta yeni bir pano oluşturur. Pano oluşturulduktan sonra yöneticilere değişiklik hakkında e-posta gönderilir ve kullanıcılar atamaya başlayabilir. Bu uç nokta sağlanan numaralar için bir pano oluşturabilir. GET /dashboards/provisioning kullanarak belirli bir alan kodunda sağlanan numaraları arayabilirsiniz. Telefon numarası zaten kullanılıyorsa, Hatalı İstek özel durumu oluşturulur.
Verilen kimlikle bir grubu güncelleştirir	Grubun sayısal kimliğini kullanarak grubun adını güncelleştirir. Geçirilen grup kimliği yoksa, çağrı başarısız olur.
Verilen telefon numarasını içeren kişiye ileti gönderme	İleti gönderir (verilen telefon numarasının ileti geçmişi yoksa yeni bir konuşma başlatır).
Yeni grup oluşturur	Sağlanan ada sahip yeni bir grup oluşturur.
Yeni ödeme oluşturur	Sağlanan kişiye verilen iletiyle yeni bir ödeme oluşturur.
Ödemeyi ödendi olarak işaretleme	Bir ödemeyi "ödendi" olarak kapatır. Ödemenin ödeme isteği portalı dışında bir yolla ödendiği durumlarda bu uç noktayı kullanın. Bu işlem, ödemeyi kapatır ve ödeme tutarını istatistiklerinize ekler. Bu uç nokta, Metin İsteği aracılığıyla gönderilen payments-portal üzerinden ödenen ödemeler için gerekli değildir; otomatik olarak ödeme olarak işaretlenir.

Belirli bir panonun adını güncelleştirme

İşlem Kimliği:

UpdateDashboardsName

Panoyu güncelleştirir. Bu, panonun telefon numarasını değiştirmez. Başka bir panonun kişileriyle yeni bir numara istiyorsanız, POST içeren yeni bir pano oluşturmanız ve toplu dışarı/içeri aktarma işlemiyle kişileri eklemeniz gerekir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Pano adı	name		string	Panonun yeni adı.

Döndürülenler

Name	Yol	Tür	Description
kimlik	id	integer	Panonun sayısal kimliği.
name	name	string	Panonun adı.
phone	phone	string	Bu panoyla ilişkilendirilmiş metin numarası.

Belirtilen filtreleme ölçütüyle eşleşen tüm kişileri alma

İşlem Kimliği:

GetContacts

Belirtilen filtreleme ölçütüyle eşleşen tüm kişileri alır. Yalnızca belirtilen pano aranacak; kullanılabilir bir sayı için hesap düzeyinde arama yoktur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Arama yapmak için kişinin telefon numarası	contact_phone_number		string	Kişileri filtrelemek için telefon numarası.
UTC saatinde 'Son ileti-zaman gönderildi' arama zaman damgası	last_message_timestamp_before_utc		date-time	Gönderilen veya alınan son iletiye göre kişileri aramak için kesme süresi. Bu süreden sonra ileti gönderen kişi gösterilmez.
'Son ileti-saat sonra gönderildi' arama zaman damgası UTC saati	last_message_timestamp_after_utc		date-time	Gönderilen veya alınan son iletiye göre kişileri aramak için kesme süresi. Son gönderilen ileti bu saatten önce olan hiçbir kişi gösterilmez.
'Daha önce oluşturuldu' arama zaman damgası	contact_created_before		date-time	Kişileri oluşturdukları zamana göre arama için kesme süresi. Bu süreden sonra oluşturulmuş hiçbir kişi gösterilmez.
'Sonra oluşturuldu' arama zaman damgası	contact_created_after		date-time	Kişileri oluşturdukları zamana göre arama için kesme süresi. Bu saatten önce oluşturulmuş hiçbir kişi gösterilmez.
Kişinin konuşmasının çözümlenip çözümlenmediği	is_resolved		boolean	Konuşmaları çözülen kişilerin aranıp aranmayacağı.
Kişinin engellenip engellenmediği	is_blocked		boolean	Engellenen kişilerin aranıp aranmayacağı.
Kişinin arşivlenip arşivlendirilmediği	is_archived		boolean	Arşivlenen kişilerin aranıp aranmayacağı.
Kişinin gizlenip gizlenmediği	is_suppressed		boolean	Gizlenen kişilerin aranıp aranmayacağı.
Kişinin geri çevirip geri çevirmediği	has_opted_out		boolean	Metin almayı geri çeviren kişilerin aranıp aranmayacağı.
'Son ileti-zaman önce gönderildi' arama zaman damgası	last_message_sent_before		date-time	Müşteriye son iletinin gönderildiği zamana göre kişileri aramak için kesme süresi. Bu süreden sonra ileti gönderen kişi gösterilmez. Yerel saat olarak zaman damgasını kullanır. UTC saatinde zaman damgasına göre filtrelemek için last_message_sent_before_utc
'Son ileti-sonra gönderilen zaman' arama zaman damgası	last_message_sent_after		date-time	Müşteriye son iletinin gönderildiği zamana göre kişileri aramak için kesme süresi. Son gönderilen ileti bu saatten önce olan hiçbir kişi gösterilmez. Yerel saat olarak zaman damgasını kullanır. UTC saatinde zaman damgasına göre filtrelemek için last_message_sent_after_utc
'Son ileti-zaman önce alındı' arama zaman damgası	last_message_received_before		date-time	Müşteriden alınan son iletiye göre kişileri aramak için kesme süresi. Bu süreden sonra ileti alan kişi gösterilmez. Yerel saat olarak zaman damgasını kullanır. UTC saatinde zaman damgasına göre filtrelemek için last_message_sent_before_utc
'Son ileti-saat alındı' arama zaman damgası	last_message_received_after		date-time	Müşteriden alınan son iletiye göre kişileri aramak için kesme süresi. Son gönderilen ileti bu saatten önce olan hiçbir kişi gösterilmez. Yerel saat olarak zaman damgasını kullanır. UTC saatinde zaman damgasına göre filtrelemek için last_message_sent_before_utc
Kişi Etiketleri	tags		string	Kişileri filtrelemek için etiketlere başvuran guid'lerin virgülle ayrılmış listesi.
Kişi Grupları	groups		string	Kişileri filtrelemek için gruplara başvuran tamsayı kimliklerinin virgülle ayrılmış listesi.
Filtre ölçütü olarak özel alanın kimliği	custom_field_id_1		string	Kişileri filtrelemek için özel alana başvuran guid.
Filtre ölçütü olarak özel alanın değeri	custom_field_value_1		string	Kişileri filtrelemek için özel alana başvuran değer.
Filtre ölçütü olarak ikinci özel alanın kimliği	custom_field_id_2		string	Kişileri filtrelemek için ikinci özel alana başvuran guid.
Filtre ölçütü olarak ikinci özel alanın değeri	custom_field_value_2		string	Kişileri filtrelemek için ikinci özel alana başvuran değer.
Filtre ölçütü olarak üçüncü özel alanın kimliği	custom_field_id_3		string	Kişileri filtrelemek için üçüncü özel alana başvuran guid.
Filtre ölçütü olarak üçüncü özel alanın değeri	custom_field_value_3		string	Kişileri filtrelemek için üçüncü özel alana başvuran değer.
Alınacak numara sayfası	page	True	integer	Alınacak varlıkların sayfası. Değerler alırken, sayfa başına page_size tarafından tanımlanan maksimum boyut vardır. Sayfa son sayfadan büyükse boş bir dizi döndürülür.
Sayfa başına alınacak her varlığın miktarı	page_size	True	integer	Alınacak her sayfanın boyutu. Değerler alırken bu, sayfa parametresi tarafından yapılan sonraki sayfalara erişirken sayfa başına en büyük boyut olur.
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.

Döndürülenler

Name	Yol	Tür	Description
page	meta.page	integer	Varlıkların sayfası. Bu sayfadaki varlık miktarı page_size tarafından tanımlanır.
page_size	meta.page_size	integer	Bu sayfaya gelen varlık sayısı.
total_items	meta.total_items	integer	Sayfa boyutuna veya numarasına bakılmaksızın veritabanında kullanılabilir varlık sayısı. Diğer sayfaları görmek için istekteki sayfa numarasını değiştirin.
items	items	array of object	Metin İsteği'nden alınan kişi varlıklarının listesi.
telefon_numarası	items.phone_number	string	Bu kişinin telefon numarası.
first_name	items.first_name	string	Bu kişinin adı.
last_name	items.last_name	string	Bu kişinin soyadı.
display_name	items.display_name	string	Bu kişinin tam adı. Bu, kişileri görüntülerken web uygulamasında görüntülenen varsayılan addır.
is_suppressed	items.is_suppressed	boolean	Bu kişiyle yapılan konuşmanın gizlenip gizlenmediği ve bu nedenle alındığında ileti kuyruğunun en üstüne gönderilip gönderilmediği.
is_archived	items.is_archived	boolean	Bu kişiyle yapılan konuşmanın arşivlenip arşivlenmiş olmadığı ve bu nedenle konuşmaları sorgularken (varsayılan olarak) görülemeyeceği.
is_blocked	items.is_blocked	boolean	Bu kişiyle yapılan konuşmanın engellenip engellenmediği ve bu nedenle alınıp alınmadığı veya depolanmadığı.
suppressed_reason	items.suppressed_reason	string	Kişiyi gizleme nedenini açıklayan tümcecik. is_suppressed false ise, bu null olur.
not	items.note	string	Kişiyi açıklayan kısa tümcecik. Kolaylık sağlamak için kullanılır. Bu, kişiye hiçbir zaman gösterilmez.
groups	items.groups	array of integer	Bu kişinin ait olduğu gruplara başvuran tamsayı kimlikleri dizisi.
contact_tags	items.contact_tags	array of string	Bu kişiye eklenen etiketlere başvuran guid dizisi.
custom_fields	items.custom_fields	array of object	Bu kişi için tanımlanan özel alan kimlikleri ve değerleri dizisi.
kimlik	items.custom_fields.id	string	Özel alana başvuran guid.
value	items.custom_fields.value	string	Bu kişinin bu özel alan için değeri.
is_resolved	items.is_resolved	boolean	Bu kişiyle yapılan konuşmanın çözülmüş olup olmadığı. Bu kişi tarafından alınan tüm yeni metinler bu yanlışı ayarlar.
first_contact_utc	items.first_contact_utc	string	Bu kişiye ilk iletinin gönderildiği zaman damgası.
opted_out_utc	items.opted_out_utc	string	Bu kişinin iletileri almayı ne zaman geri çevirmiş olduğu zaman damgası.
last_msg_sent_utc	items.last_msg_sent_utc	string	Bu kişiye son iletinin ne zaman gönderildiğinin zaman damgası.
last_msg_received_utc	items.last_msg_received_utc	string	Bu kişiden son iletinin alındığı zaman damgası.
total_msgs_sent	items.total_msgs_sent	integer	Bu kişiye gönderilen toplam ileti sayısı.
total_msgs_received	items.total_msgs_received	integer	Bu kişiden alınan toplam ileti sayısı.
response_count	items.response_count	integer	Kişiden gelen yanıt iletilerinin toplam sayısı.
date_created_utc	items.date_created_utc	string	İlgili kişinin ne zaman oluşturulduğunun zaman damgası.
last_contact_date_utc	items.last_contact_date_utc	string	Bu kişiden son iletinin ne zaman gönderildiğinin veya alındığının zaman damgası.
message_id	items.last_message.message_id	string	İletinin kimliği. Bu değer her ileti için benzersizdir.
body	items.last_message.body	string	Bu iletinin içeriği.
message_direction	items.last_message.message_direction	string	R veya S olmak üzere tekil karakter, bu iletinin kişiden mi alındığını yoksa onlara mı gönderildiğini gösterir.
response_by_username	items.last_message.response_by_username	string	Bu kullanıcıya en son ileti gönderen Metin İsteği kullanıcısının kullanıcı adı.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	İletinin Metin İsteği tarafından ne zaman gönderildiğine veya alındığına ilişkin zaman damgası.
delivery_status	items.last_message.delivery_status	string	Bu iletinin geçerli durumu. Bu 'gönderme', 'teslim', 'hata' veya 'gönder' olabilir.
delivery_error	items.last_message.delivery_error	string	Bu iletinin teslim edilememesi hatası. delivery_status 'error' değilse, bu değer null olur.
mms_media	items.last_message.mms_media	array of string	Bu iletinin eklerine işaret eden URL'lerin listesi. Tüm URL'ler metin isteği tarafından oluşturulan url'ler olacaktır.

Belirtilen kimlikle grubu siler

İşlem Kimliği:

DeleteGroup

Belirtilen kimlikle grubu siler. Bu, grubun üyesi olan kişiler olsa bile başarılı olur (kişiler silinmez).

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Grubun kimliği	group_id	True	integer	Silinecek grubun sayısal kimliği.

Döndürülenler

response

string

Belirtilen kimlikle ödemeyi alır

İşlem Kimliği:

GetPayment

Belirtilen kimlikle ödemeyi alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Ödemenin kimliği	payment_id	True	integer	Alınacak ödemenin sayısal kimliği.

Döndürülenler

Name	Yol	Tür	Description
payment_id	payment_id	integer	Ödemenin sayısal kimliği.
request_date	request_date	string	Bu ödemenin ilk iletisinin gönderilmek üzere kuyruğa alındığı zaman damgası.
alıcı	recipient	string	Ödeme alıcısının adı. Kişinin telefon numarasıyla ilişkilendirilmiş bir adı yoksa bu null olabilir.
açıklama	description	string	Ödemenin açıklaması. Bu, kişiye gösterilmez. Yalnızca iç kullanıcılar tarafından ödemelerle ilgili bağlam için kullanılır.
customer_phone	customer_phone	string	Bu ödemenin gönderileceği kişinin telefon numarası.
amount_requested	amount_requested	float	Bu ödemenin talep ettiği dolar cinsinden tutar.
is_past_due	is_past_due	boolean	Bu ödemenin istek tarihini geçmiş olup olmadığı.
reminder_was_sent	reminder_was_sent	boolean	Bu ödeme için bir kısa mesaj anımsatıcısı gönderilip gönderilmediği.
transaction_status	transaction_status	string	İşlemin authvia içindeki durumu. Bu değer Bilinmiyor olarak başlar.
textrequest_payment_status	textrequest_payment_status	string	Metin İsteği'nde işlemin durumu. Bu, Metin İsteği uygulamasının ödemeler sayfasında gösterilen durumu temsil eder. Gönderildi olarak başlar.
reference_number	reference_number	string	Ödemeleri hızla bulmak için kullanılabilecek ödemeler oluşturulduğunda tanımlanan kullanıcı tanımlı kimlik. Başvuru numaraları benzersiz değildir; birçok ödeme aynı başvuruya sahip olabilir.

Belirtilen panoyu siler

İşlem Kimliği:

DeleteDashboard

Belirtilen panoyu siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.

Döndürülenler

response

string

Belirtilen telefon numarasına sahip kişiyi alır

İşlem Kimliği:

GetContactByPhoneNumber

Belirtilen telefon numarasına sahip kişiyi alır

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Kişinin Telefon Numarası	phone_number	True	string	Ulaşacak kişinin telefon numarası.

Döndürülenler

Name	Yol	Tür	Description
telefon_numarası	phone_number	string	Bu kişinin telefon numarası.
first_name	first_name	string	Bu kişinin adı.
last_name	last_name	string	Bu kişinin soyadı.
display_name	display_name	string	Bu kişinin tam adı. Bu, kişileri görüntülerken web uygulamasında görüntülenen varsayılan addır.
is_suppressed	is_suppressed	boolean	Bu kişiyle yapılan konuşmanın gizlenip gizlenmediği ve bu nedenle alındığında ileti kuyruğunun en üstüne gönderilip gönderilmediği.
is_archived	is_archived	boolean	Bu kişiyle yapılan konuşmanın arşivlenip arşivlenmiş olmadığı ve bu nedenle konuşmaları sorgularken (varsayılan olarak) görülemeyeceği.
is_blocked	is_blocked	boolean	Bu kişiyle yapılan konuşmanın engellenip engellenmediği ve bu nedenle alınıp alınmadığı veya depolanmadığı.
suppressed_reason	suppressed_reason	string	Kişiyi gizleme nedenini açıklayan tümcecik. is_suppressed false ise, bu null olur.
not	note	string	Kişiyi açıklayan kısa tümcecik. Kolaylık sağlamak için kullanılır. Bu, kişiye hiçbir zaman gösterilmez.
groups	groups	array of integer	Bu kişinin ait olduğu gruplara başvuran tamsayı kimlikleri dizisi.
contact_tags	contact_tags	array of string	Bu kişiye eklenen etiketlere başvuran guid dizisi.
custom_fields	custom_fields	array of object	Bu kişi için tanımlanan özel alan kimlikleri ve değerleri dizisi.
kimlik	custom_fields.id	string	Özel alana başvuran guid.
value	custom_fields.value	string	Bu kişinin bu özel alan için değeri.
is_resolved	is_resolved	boolean	Bu kişiyle yapılan konuşmanın çözülmüş olup olmadığı. Bu kişi tarafından alınan tüm yeni metinler bu yanlışı ayarlar.
first_contact_utc	first_contact_utc	string	Bu kişiye ilk iletinin gönderildiği zaman damgası.
opted_out_utc	opted_out_utc	string	Bu kişinin iletileri almayı ne zaman geri çevirmiş olduğu zaman damgası.
last_msg_sent_utc	last_msg_sent_utc	string	Bu kişiye son iletinin ne zaman gönderildiğinin zaman damgası.
last_msg_received_utc	last_msg_received_utc	string	Bu kişiden son iletinin alındığı zaman damgası.
total_msgs_sent	total_msgs_sent	integer	Bu kişiye gönderilen toplam ileti sayısı.
total_msgs_received	total_msgs_received	integer	Bu kişiden alınan toplam ileti sayısı.
response_count	response_count	integer	Kişiden gelen yanıt iletilerinin toplam sayısı.
date_created_utc	date_created_utc	string	İlgili kişinin ne zaman oluşturulduğunun zaman damgası.
last_contact_date_utc	last_contact_date_utc	string	Bu kişiden son iletinin gönderildiği veya alındığı zaman damgası.
message_id	last_message.message_id	string	İletinin kimliği. Bu değer her ileti için benzersizdir.
body	last_message.body	string	Bu iletinin içeriği.
message_direction	last_message.message_direction	string	R veya S olmak üzere tekil karakter, bu iletinin kişiden mi alındığını yoksa onlara mı gönderildiğini gösterir.
response_by_username	last_message.response_by_username	string	Bu kullanıcıya en son ileti gönderen Metin İsteği kullanıcısının kullanıcı adı.
message_timestamp_utc	last_message.message_timestamp_utc	string	İletinin Metin İsteği tarafından ne zaman gönderildiğine veya alındığına ilişkin zaman damgası.
delivery_status	last_message.delivery_status	string	Bu iletinin geçerli durumu. Bu 'gönderme', 'teslim', 'hata' veya 'gönder' olabilir.
delivery_error	last_message.delivery_error	string	Bu iletinin teslim edilememesi hatası. delivery_status 'error' değilse, bu değer null olur.
mms_media	last_message.mms_media	array of string	Bu iletinin eklerine işaret eden URL'lerin listesi. Tüm URL'ler metin isteği tarafından oluşturulan url'ler olacaktır.

Belirtilen telefon numarasına sahip kişiyi siler

İşlem Kimliği:

DeleteContact

Belirtilen telefon numarasına sahip kişiyi siler

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Kişi telefon numarası	phone_number	True	string	Silinecek kişinin telefon numarası.

Döndürülenler

response

string

Belirtilen ödemeyi iptal eder

İşlem Kimliği:

CancelPayment

Belirtilen ödemeyi iptal eder ve kullanıcıya ödemenin iptal edildiğini iletir. Ödemeler düzenlenemez, bu nedenle yeni bir ödemeyi iptal etmek ve vermek, bir ödemeyi düzeltmenin en iyi yoludur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Ödemenin kimliği	payment_id	True	integer	Güncelleştirilecek ödemenin sayısal kimliği.

Döndürülenler

Name	Yol	Tür	Description
payment_id	payment_id	integer	Ödemenin sayısal kimliği.
request_date	request_date	string	Bu ödemenin ilk iletisinin gönderilmek üzere kuyruğa alındığı zaman damgası.
alıcı	recipient	string	Ödeme alıcısının adı. Kişinin telefon numarasıyla ilişkilendirilmiş bir adı yoksa bu null olabilir.
açıklama	description	string	Ödemenin açıklaması. Bu, kişiye gösterilmez. Yalnızca iç kullanıcılar tarafından ödemelerle ilgili bağlam için kullanılır.
customer_phone	customer_phone	string	Bu ödemenin gönderileceği kişinin telefon numarası.
amount_requested	amount_requested	float	Bu ödemenin talep ettiği dolar cinsinden tutar.
is_past_due	is_past_due	boolean	Bu ödemenin istek tarihini geçmiş olup olmadığı.
reminder_was_sent	reminder_was_sent	boolean	Bu ödeme için bir kısa mesaj anımsatıcısı gönderilip gönderilmediği.
transaction_status	transaction_status	string	İşlemin authvia içindeki durumu. Bu değer Bilinmiyor olarak başlar.
textrequest_payment_status	textrequest_payment_status	string	Metin İsteği'nde işlemin durumu. Bu, Metin İsteği uygulamasının ödemeler sayfasında gösterilen durumu temsil eder. Gönderildi olarak başlar.
reference_number	reference_number	string	Ödemeleri hızla bulmak için kullanılabilecek ödemeler oluşturulduğunda tanımlanan kullanıcı tanımlı kimlik. Başvuru numaraları benzersiz değildir; birçok ödeme aynı başvuruya sahip olabilir.

Bir grubu kimliğine göre alma

İşlem Kimliği:

GetGroupById

Belirtilen kimlikle grubu alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Grubun kimliği	group_id	True	integer	Alınacak grubun sayısal kimliği.

Döndürülenler

Name	Yol	Tür	Description
kimlik	id	integer	Grubun sayısal kimliği.
group_member_count	group_member_count	integer	Grubun üye sayısı.
is_keyword	is_keyword	boolean	Bu grup bir anahtar sözcük grubudur. Kullanıcı bir anahtar sözcük ayarladığında bu tür gruplar otomatik olarak oluşturulur. Kişiler kaydolduğunda otomatik olarak eklenir.
name	name	string	Bu grubun adı.
Notlar	notes	string	Bu gruptaki tüm notlar.
last_message_sent_utc	last_message_sent_utc	string	Bu grup için son grup iletisinin gönderildiği zaman damgası.

Bir kişinin telefon numarasına göre konuşmanın iletilerini alma

İşlem Kimliği:

GetMessagesByContactPhone

Belirtilen pano ve telefon numarası arasındaki konuşmayı alın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alınacak numara sayfası	page	True	integer	Alınacak varlıkların sayfası. Değerler alırken, sayfa başına page_size tarafından tanımlanan maksimum boyut vardır. Sayfa son sayfadan büyükse boş bir dizi döndürülür.
Sayfa başına alınacak her varlığın miktarı	page_size	True	integer	Alınacak her sayfanın boyutu. Değerler alırken bu, sayfa parametresi tarafından yapılan sonraki sayfalara erişirken sayfa başına en büyük boyut olur.
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Arama yapmak için kişinin telefon numarası	phone_number	True	string	İleti almak için kişinin telefon numarası.

Döndürülenler

Name	Yol	Tür	Description
page	meta.page	integer	Varlıkların sayfası. Bu sayfadaki varlık miktarı page_size tarafından tanımlanır.
page_size	meta.page_size	integer	Bu sayfaya gelen varlık sayısı.
total_items	meta.total_items	integer	Sayfa boyutuna veya numarasına bakılmaksızın veritabanında kullanılabilir varlık sayısı. Diğer sayfaları görmek için istekteki sayfa numarasını değiştirin.
items	items	array of object	Metin İsteği'nden alınan ileti varlıklarının listesi.
message_id	items.message_id	string	İletinin kimliği. Bu değer her ileti için benzersizdir.
body	items.body	string	Bu iletinin içeriği.
message_direction	items.message_direction	string	R veya S olmak üzere tekil karakter, bu iletinin kişiden mi alındığını yoksa onlara mı gönderildiğini gösterir.
response_by_username	items.response_by_username	string	Bu kullanıcıya en son ileti gönderen Metin İsteği kullanıcısının kullanıcı adı.
message_timestamp_utc	items.message_timestamp_utc	string	İletinin Metin İsteği tarafından ne zaman gönderildiğine veya alındığına ilişkin zaman damgası.
delivery_status	items.delivery_status	string	Bu iletinin geçerli durumu. Bu 'gönderme', 'teslim', 'hata' veya 'gönder' olabilir.
delivery_error	items.delivery_error	string	Bu iletinin teslim edilememesi hatası. delivery_status 'error' değilse, bu değer null olur.
mms_media	items.mms_media	array of string	Bu iletinin eklerine işaret eden URL'lerin listesi. Tüm URL'ler metin isteği tarafından oluşturulan url'ler olacaktır.

Bu pano hakkında bilgi edinin

İşlem Kimliği:

GetDashboard

Panonun adını ve telefonunu döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.

Döndürülenler

Name	Yol	Tür	Description
kimlik	id	integer	Panonun sayısal kimliği.
name	name	string	Panonun adı.
phone	phone	string	Bu panoyla ilişkilendirilmiş metin numarası.

Bu pano için tüm konuşmaları alır

İşlem Kimliği:

GetConversations

Bu pano için tüm konuşmaları alır ve her konuşmanın son iletisiyle ilgili bilgileri içerir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kişi Etiketleri	tags		string	Konuşmaları filtrelemek için etiketlere başvuran guid'lerin virgülle ayrılmış listesi.
Yalnızca çözümlenen konuşmaların gösterilip gösterilmeyeceğini	show_unresolved_only		string	Yalnızca konuşmaları çözülmüş olan kişilerin aranıp aranmayacağı. Bu yanlışsa, hem çözülmüş hem de çözümlenmemiş konuşmalar gösterilir.
Arşivlenmiş konuşmaların dahil edilip edilmeyeceği	include_archived		string	Arşivlenmiş kişilerle konuşmaların dahil edilip edilmeyeceği.
Telefon numaraları ve kişi adı için filtreleme ölçütü terimi	search		string	Konuşmaları telefon numarasına veya görünen ada göre filtrelemek için arama terimi. Arama terimi tam ad veya telefon numarasından küçükse, arama kısmen eşleşen tüm konuşmaları döndürür.
Alınacak numara sayfası	page		integer	Alınacak varlıkların sayfası. Değerler alırken, sayfa başına page_size tarafından tanımlanan maksimum boyut vardır. Sayfa son sayfadan büyükse boş bir dizi döndürülür.
Sayfa başına alınacak her varlığın miktarı	page_size		integer	Alınacak her sayfanın boyutu. Değerler alırken bu, sayfa parametresi tarafından yapılan sonraki sayfalara erişirken sayfa başına en büyük boyut olur.
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.

Döndürülenler

Name	Yol	Tür	Description
page	meta.page	integer	Varlıkların sayfası. Bu sayfadaki varlık miktarı page_size tarafından tanımlanır.
page_size	meta.page_size	integer	Bu sayfaya gelen varlık sayısı.
total_items	meta.total_items	integer	Sayfa boyutuna veya numarasına bakılmaksızın veritabanında kullanılabilir varlık sayısı. Diğer sayfaları görmek için istekteki sayfa numarasını değiştirin.
items	items	array of object	Metin İsteği'nden alınan konuşma varlıklarının listesi.
telefon_numarası	items.phone_number	string	Kişinin telefon numarası.
message_id	items.last_message.message_id	string	İletinin kimliği. Bu değer her ileti için benzersizdir.
body	items.last_message.body	string	Bu iletinin içeriği.
message_direction	items.last_message.message_direction	string	R veya S olmak üzere tekil karakter, bu iletinin kişiden mi alındığını yoksa onlara mı gönderildiğini gösterir.
response_by_username	items.last_message.response_by_username	string	Bu kullanıcıya en son ileti gönderen Metin İsteği kullanıcısının kullanıcı adı.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	İletinin Metin İsteği tarafından ne zaman gönderildiğine veya alındığına ilişkin zaman damgası.
delivery_status	items.last_message.delivery_status	string	Bu iletinin geçerli durumu. Bu 'gönderme', 'teslim', 'hata' veya 'gönder' olabilir.
delivery_error	items.last_message.delivery_error	string	Bu iletinin teslim edilememesi hatası. delivery_status 'error' değilse, bu değer null olur.
mms_media	items.last_message.mms_media	array of string	Bu iletinin eklerine işaret eden URL'lerin listesi. Tüm URL'ler metin isteği tarafından oluşturulan url'ler olacaktır.

Hesaptaki tüm panoları alma

İşlem Kimliği:

GetDashboards

Bir hesaptaki tüm panoları alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alınacak numara sayfası	page		integer	Alınacak varlıkların sayfası. Değerler alırken, sayfa başına page_size tarafından tanımlanan maksimum boyut vardır. Sayfa son sayfadan büyükse boş bir dizi döndürülür.
Sayfa başına alınacak her varlığın miktarı	page_size		integer	Alınacak her sayfanın boyutu. Değerler alırken bu, sayfa parametresi tarafından yapılan sonraki sayfalara erişirken sayfa başına en büyük boyut olur.

Döndürülenler

Name	Yol	Tür	Description
page	meta.page	integer	Varlıkların sayfası. Bu sayfadaki varlık miktarı page_size tarafından tanımlanır.
page_size	meta.page_size	integer	Bu sayfaya gelen varlık sayısı.
total_items	meta.total_items	integer	Sayfa boyutuna veya numarasına bakılmaksızın veritabanında kullanılabilir varlık sayısı. Diğer sayfaları görmek için istekteki sayfa numarasını değiştirin.
items	items	array of object	Metin İsteği'nden alınan pano varlıklarının listesi.
kimlik	items.id	integer	Panonun sayısal kimliği.
name	items.name	string	Panonun adı.
phone	items.phone	string	Bu panoyla ilişkilendirilmiş metin numarası.

Kişi oluşturma veya güncelleştirme

İşlem Kimliği:

CreateContact

Bir kişiyi oluşturur veya güncelleştirir (verilen telefon numarasıyla zaten var olup olmadığına bağlı olarak).

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Kişi telefon numarası	phone_number	True	string	Oluşturulacak veya güncelleştirilecek kişinin telefon numarası.
Kişinin adı	first_name		string	Kişinin yeni adı.
Kişinin soyadı	last_name		string	Kişinin yeni soyadı.
Kişinin tam adı	display_name		string	Kişinin yeni tam adı. Bu, kişileri görüntülerken web uygulamasında görüntülenen varsayılan addır.
Bu kişiden gelen iletilerin gizlenip gizlenmediği	is_suppressed		boolean	Bu kişiyle yapılan konuşmaların gizlenip gizlenmeyeceğini ve bu nedenle alındığında ileti kuyruğunun en üstüne gönderilmeyeceğini belirler.
Bu kişiden gelen iletilerin arşivlenip arşivlendirilmediği	is_archived		boolean	Bu kişiyle yapılan konuşmaların arşivlenip arşivlenmeyeceğini belirler ve bu nedenle konuşmaları sorgularken (varsayılan olarak) görülemez.
Bu kişiden gelen iletilerin engellenip engellenmediği	is_blocked		boolean	Bu kişiyle yapılan konuşmaların engellenip engellenmeyeceğini ve bu nedenle alınıp alınmayacağını veya depolanmadığını belirler.
Bu kişiyi gizleme nedeni	suppressed_reason		string	Kişiyi gizleme nedenini açıklayan tümcecik.
Kişi Notu	note		string	Kişiyi açıklayan kısa tümcecik. Kolaylık sağlamak için kullanılır. Bu, kişiye hiçbir zaman gösterilmez.
Kişi Grupları	groups		array of integer	Bu kişinin ait olacağı gruplara başvuran tamsayı kimlikleri dizisi.
Kişi Etiketleri	contact_tags		array of string	Bu kişiye eklenen etiketlere başvuran guid dizisi.
Özel alan kimliği	id		string	Özel alana başvuran guid.
Özel alan değeri	value		string	Bu kişinin bu özel alan için değeri.
Bu kişiyle yapılan geçerli konuşmanın çözümlenip çözümlenmediği	is_resolved		boolean	Bu kişiyle yapılan geçerli konuşmanın çözümlenip çözümlenmediğini belirler. Bu kişi tarafından alınan tüm yeni metinler bu yanlışı ayarlar.

Döndürülenler

Name	Yol	Tür	Description
telefon_numarası	phone_number	string	Bu kişinin telefon numarası.
first_name	first_name	string	Bu kişinin adı.
last_name	last_name	string	Bu kişinin soyadı.
display_name	display_name	string	Bu kişinin tam adı. Bu, kişileri görüntülerken web uygulamasında görüntülenen varsayılan addır.
is_suppressed	is_suppressed	boolean	Bu kişiyle yapılan konuşmanın gizlenip gizlenmediği ve bu nedenle alındığında ileti kuyruğunun en üstüne gönderilip gönderilmediği.
is_archived	is_archived	boolean	Bu kişiyle yapılan konuşmanın arşivlenip arşivlenmiş olmadığı ve bu nedenle konuşmaları sorgularken (varsayılan olarak) görülemeyeceği.
is_blocked	is_blocked	boolean	Bu kişiyle yapılan konuşmanın engellenip engellenmediği ve bu nedenle alınıp alınmadığı veya depolanmadığı.
suppressed_reason	suppressed_reason	string	Kişiyi gizleme nedenini açıklayan tümcecik. is_suppressed false ise, bu null olur.
not	note	string	Kişiyi açıklayan kısa tümcecik. Kolaylık sağlamak için kullanılır. Bu, kişiye hiçbir zaman gösterilmez.
groups	groups	array of integer	Bu kişinin ait olduğu gruplara başvuran tamsayı kimlikleri dizisi.
contact_tags	contact_tags	array of string	Bu kişiye eklenen etiketlere başvuran guid dizisi.
custom_fields	custom_fields	array of object	Bu kişi için tanımlanan özel alan kimlikleri ve değerleri dizisi.
kimlik	custom_fields.id	string	Özel alana başvuran guid.
value	custom_fields.value	string	Bu kişinin bu özel alan için değeri.
is_resolved	is_resolved	boolean	Bu kişiyle yapılan konuşmanın çözülmüş olup olmadığı. Bu kişi tarafından alınan tüm yeni metinler bu yanlışı ayarlar.
first_contact_utc	first_contact_utc	string	Bu kişiye ilk iletinin gönderildiği zaman damgası.
opted_out_utc	opted_out_utc	string	Bu kişinin iletileri almayı ne zaman geri çevirmiş olduğu zaman damgası.
last_msg_sent_utc	last_msg_sent_utc	string	Bu kişiye son iletinin ne zaman gönderildiğinin zaman damgası.
last_msg_received_utc	last_msg_received_utc	string	Bu kişiden son iletinin alındığı zaman damgası.
total_msgs_sent	total_msgs_sent	integer	Bu kişiye gönderilen toplam ileti sayısı.
total_msgs_received	total_msgs_received	integer	Bu kişiden alınan toplam ileti sayısı.
response_count	response_count	integer	Kişiden gelen yanıt iletilerinin toplam sayısı.
date_created_utc	date_created_utc	string	İlgili kişinin ne zaman oluşturulduğunun zaman damgası.
last_contact_date_utc	last_contact_date_utc	string	Bu kişiden son iletinin ne zaman gönderildiğinin veya alındığının zaman damgası.
message_id	last_message.message_id	string	İletinin kimliği. Bu değer her ileti için benzersizdir.
body	last_message.body	string	Bu iletinin içeriği.
message_direction	last_message.message_direction	string	R veya S olmak üzere tekil karakter, bu iletinin kişiden mi alındığını yoksa onlara mı gönderildiğini gösterir.
response_by_username	last_message.response_by_username	string	Bu kullanıcıya en son ileti gönderen Metin İsteği kullanıcısının kullanıcı adı.
message_timestamp_utc	last_message.message_timestamp_utc	string	İletinin Metin İsteği tarafından ne zaman gönderildiğine veya alındığına ilişkin zaman damgası.
delivery_status	last_message.delivery_status	string	Bu iletinin geçerli durumu. Bu 'gönderme', 'teslim', 'hata' veya 'gönder' olabilir.
delivery_error	last_message.delivery_error	string	Bu iletinin teslim edilememesi hatası. delivery_status 'error' değilse, bu değer null olur.
mms_media	last_message.mms_media	array of string	Bu iletinin eklerine işaret eden URL'lerin listesi. Tüm URL'ler metin isteği tarafından oluşturulan url'ler olacaktır.

Kişileri toplu güncelleştirme

İşlem Kimliği:

BulkUpdateContacts

Yalnızca belirtilen panoda kişiler eklenir; kişiler panoya göre düzenlenir ve kullanılabilir bir sayı için hesap düzeyinde arama yoktur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Kişi telefon numarası	phone_number		string	Oluşturulacak veya güncelleştirilecek kişinin telefon numarası.
Kişinin adı	first_name		string	Kişinin yeni adı.
Kişinin soyadı	last_name		string	Kişinin yeni soyadı.
Kişinin tam adı	display_name		string	Kişinin yeni tam adı. Bu, kişileri görüntülerken web uygulamasında görüntülenen varsayılan addır.
Bu kişiden gelen iletilerin gizlenip gizlenmediği	is_suppressed		boolean	Bu kişiyle yapılan konuşmaların gizlenip gizlenmeyeceğini ve bu nedenle alındığında ileti kuyruğunun en üstüne gönderilmeyeceğini belirler.
Bu kişiden gelen iletilerin arşivlenip arşivlendirilmediği	is_archived		boolean	Bu kişiyle yapılan konuşmaların arşivlenip arşivlenmeyeceğini belirler ve bu nedenle konuşmaları sorgularken (varsayılan olarak) görülemez.
Bu kişiden gelen iletilerin engellenip engellenmediği	is_blocked		boolean	Bu kişiyle yapılan konuşmaların engellenip engellenmeyeceğini ve bu nedenle alınıp alınmayacağını veya depolanmadığını belirler.
Bu kişiyi gizleme nedeni	suppressed_reason		string	Kişiyi gizleme nedenini açıklayan tümcecik.
Kişi notu	note		string	Kişiyi açıklayan kısa tümcecik. Kolaylık sağlamak için kullanılır. Bu, kişiye hiçbir zaman gösterilmez.
Kişi grupları	groups		array of integer	Bu kişinin ait olacağı gruplara başvuran tamsayı kimlikleri dizisi.
Kişi etiketleri	contact_tags		array of string	Bu kişiye eklenen etiketlere başvuran guid dizisi.
Özel alan kimliği	id		string	Özel alana başvuran guid.
Özel alan değeri	value		string	Bu kişinin bu özel alan için değeri.
Bu kişiyle yapılan geçerli konuşmanın çözümlenip çözümlenmediği	is_resolved		boolean	Bu kişiyle yapılan geçerli konuşmanın çözümlenip çözümlenmediğini belirler. Bu kişi tarafından alınan tüm yeni metinler bu yanlışı ayarlar.

Döndürülenler

Name	Yol	Tür	Description
		array of object
telefon_numarası	phone_number	string	Bu kişinin telefon numarası.
first_name	first_name	string	Bu kişinin adı.
last_name	last_name	string	Bu kişinin soyadı.
display_name	display_name	string	Bu kişinin tam adı. Bu, kişileri görüntülerken web uygulamasında görüntülenen varsayılan addır.
is_suppressed	is_suppressed	boolean	Bu kişiyle yapılan konuşmanın gizlenip gizlenmediği ve bu nedenle alındığında ileti kuyruğunun en üstüne gönderilip gönderilmediği.
is_archived	is_archived	boolean	Bu kişiyle yapılan konuşmanın arşivlenip arşivlenmiş olmadığı ve bu nedenle konuşmaları sorgularken (varsayılan olarak) görülemeyeceği.
is_blocked	is_blocked	boolean	Bu kişiyle yapılan konuşmanın engellenip engellenmediği ve bu nedenle alınıp alınmadığı veya depolanmadığı.
suppressed_reason	suppressed_reason	string	Kişiyi gizleme nedenini açıklayan tümcecik. is_suppressed false ise, bu null olur.
not	note	string	Kişiyi açıklayan kısa tümcecik. Kolaylık sağlamak için kullanılır. Bu, kişiye hiçbir zaman gösterilmez.
groups	groups	array of integer	Bu kişinin ait olduğu gruplara başvuran tamsayı kimlikleri dizisi.
contact_tags	contact_tags	array of string	Bu kişiye eklenen etiketlere başvuran guid dizisi.
custom_fields	custom_fields	array of object	Bu kişi için tanımlanan özel alan kimlikleri ve değerleri dizisi.
kimlik	custom_fields.id	string	Özel alana başvuran guid.
value	custom_fields.value	string	Bu kişinin bu özel alan için değeri.
is_resolved	is_resolved	boolean	Bu kişiyle yapılan konuşmanın çözülmüş olup olmadığı. Bu kişi tarafından alınan tüm yeni metinler bu yanlışı ayarlar.
first_contact_utc	first_contact_utc	string	Bu kişiye ilk iletinin gönderildiği zaman damgası.
opted_out_utc	opted_out_utc	string	Bu kişinin iletileri almayı ne zaman geri çevirmiş olduğu zaman damgası.
last_msg_sent_utc	last_msg_sent_utc	string	Bu kişiye son iletinin ne zaman gönderildiğinin zaman damgası.
last_msg_received_utc	last_msg_received_utc	string	Bu kişiden son iletinin alındığı zaman damgası.
total_msgs_sent	total_msgs_sent	integer	Bu kişiye gönderilen toplam ileti sayısı.
total_msgs_received	total_msgs_received	integer	Bu kişiden alınan toplam ileti sayısı.
response_count	response_count	integer	Kişiden gelen yanıt iletilerinin toplam sayısı.
date_created_utc	date_created_utc	string	İlgili kişinin ne zaman oluşturulduğunun zaman damgası.
last_contact_date_utc	last_contact_date_utc	string	Bu kişiden son iletinin ne zaman gönderildiğinin veya alındığının zaman damgası.
message_id	last_message.message_id	string	İletinin kimliği. Bu değer her ileti için benzersizdir.
body	last_message.body	string	Bu iletinin içeriği.
message_direction	last_message.message_direction	string	R veya S olmak üzere tekil karakter, bu iletinin kişiden mi alındığını yoksa onlara mı gönderildiğini gösterir.
response_by_username	last_message.response_by_username	string	Bu kullanıcıya en son ileti gönderen Metin İsteği kullanıcısının kullanıcı adı.
message_timestamp_utc	last_message.message_timestamp_utc	string	İletinin Metin İsteği tarafından ne zaman gönderildiğine veya alındığına ilişkin zaman damgası.
delivery_status	last_message.delivery_status	string	Bu iletinin geçerli durumu. Bu 'gönderme', 'teslim', 'hata' veya 'gönder' olabilir.
delivery_error	last_message.delivery_error	string	Bu iletinin teslim edilememesi hatası. delivery_status 'error' değilse, bu değer null olur.
mms_media	last_message.mms_media	array of string	Bu iletinin eklerine işaret eden URL'lerin listesi. Tüm URL'ler metin isteği tarafından oluşturulan url'ler olacaktır.

Konuşmayı Arşivle

İşlem Kimliği:

ArchiveConversation

Bir konuşmayı arşivler ve tüm konuşma alma uç noktalarının sonuçlarından kaldırır. Müşteri Metin İsteği numaranıza metin gönderirse veya müşteriye Metin İsteği numaranızdan bir metin gönderirseniz konuşma otomatik olarak arşivlenir. Konuşmaları arşivleme, gelecekte konuşmayı planlamadığınız müşterilerden dağınıklığı ortadan kaldırmanın iyi bir yoludur. Bir müşteri daha fazla SMS mesajı göndermenizi önlemek için "DUR" iletisi gönderirse konuşmanın otomatik olarak arşivlendiğini unutmayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Konuşmanın Telefon Numarası	phone_number	True	string	Arşive konulacak konuşmanın telefon numarası.

Döndürülenler

response

string

Konuşmayı Arşivleme

İşlem Kimliği:

UnarchiveConversation

Bir konuşmayı arşivler. Bir konuşma arşivlenmemiş durumda olduğunda, bir kez daha kuyrukta görünür. ayrıca /conversations uç noktası tarafından döndürülen konuşmalarda da görünür. Bir konuşma zaten arşivlenmemişse, bu yöntemin hiçbir etkisi yoktur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Konuşmanın Telefon Numarası	phone_number	True	string	Arşive konulacak konuşmanın telefon numarası.

Döndürülenler

response

string

Kullanıcıya belirtilen ödemeyi ödemesini anımsatan bir izleme metni gönderin

İşlem Kimliği:

SendPaymentReminder

Belirtilen ödemeyi ödemek için kişiye bir anımsatıcı gönderir. İletinin içeriği otomatik olarak oluşturulur. İstenmeyen postaları önlemek için ödeme başına yalnızca bir anımsatıcı gönderilebilir

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Ödemenin kimliği	payment_id	True	integer	Güncelleştirilecek ödemenin sayısal kimliği.

Döndürülenler

Name	Yol	Tür	Description
payment_id	payment_id	integer	Ödemenin sayısal kimliği.
request_date	request_date	string	Bu ödemenin ilk iletisinin gönderilmek üzere kuyruğa alındığı zaman damgası.
alıcı	recipient	string	Ödeme alıcısının adı. Kişinin telefon numarasıyla ilişkilendirilmiş bir adı yoksa bu null olabilir.
açıklama	description	string	Ödemenin açıklaması. Bu, kişiye gösterilmez. Yalnızca iç kullanıcılar tarafından ödemelerle ilgili bağlam için kullanılır.
customer_phone	customer_phone	string	Bu ödemenin gönderileceği kişinin telefon numarası.
amount_requested	amount_requested	float	Bu ödemenin talep ettiği dolar cinsinden tutar.
is_past_due	is_past_due	boolean	Bu ödemenin istek tarihini geçmiş olup olmadığı.
reminder_was_sent	reminder_was_sent	boolean	Bu ödeme için bir kısa mesaj anımsatıcısı gönderilip gönderilmediği.
transaction_status	transaction_status	string	İşlemin authvia içindeki durumu. Bu değer Bilinmiyor olarak başlar.
textrequest_payment_status	textrequest_payment_status	string	Metin İsteği'nde işlemin durumu. Bu, Metin İsteği uygulamasının ödemeler sayfasında gösterilen durumu temsil eder. Gönderildi olarak başlar.
reference_number	reference_number	string	Ödemeleri hızla bulmak için kullanılabilecek ödemeler oluşturulduğunda tanımlanan kullanıcı tanımlı kimlik. Başvuru numaraları benzersiz değildir; birçok ödeme aynı başvuruya sahip olabilir.

Tüm etiketleri alır

İşlem Kimliği:

GetTags

Bu panonun tüm etiketlerini alır. Etiketler panolar arasında benzersizdir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Alınacak numara sayfası	page	True	integer	Alınacak varlıkların sayfası. Değerler alırken, sayfa başına page_size tarafından tanımlanan maksimum boyut vardır. Sayfa son sayfadan büyükse boş bir dizi döndürülür.
Sayfa başına alınacak her varlığın miktarı	page_size	True	integer	Alınacak her sayfanın boyutu. Değerler alırken bu, sayfa parametresi tarafından yapılan sonraki sayfalara erişirken sayfa başına en büyük boyut olur.

Döndürülenler

Name	Yol	Tür	Description
page	meta.page	integer	Varlıkların sayfası. Bu sayfadaki varlık miktarı page_size tarafından tanımlanır.
page_size	meta.page_size	integer	Bu sayfaya gelen varlık sayısı.
total_items	meta.total_items	integer	Sayfa boyutuna veya numarasına bakılmaksızın veritabanında kullanılabilir varlık sayısı. Diğer sayfaları görmek için istekteki sayfa numarasını değiştirin.
items	items	array of object	Metin İsteği'nden alınan etiket varlıklarının listesi.
kimlik	items.id	string	Etiketin sayısal kimliği.
tag_color	items.tag_color	string	Etiketin rengi. Bu geçerli bir onaltılık renk kodu olmalıdır.
tag	items.tag	string	Etiketin adı.

Tüm grupları alır

İşlem Kimliği:

GetGroups

Kullanıcının hesabı için tüm grupları alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alınacak numara sayfası	page	True	integer	Alınacak varlıkların sayfası. Değerler alırken, sayfa başına page_size tarafından tanımlanan maksimum boyut vardır. Sayfa son sayfadan büyükse boş bir dizi döndürülür.
Sayfa başına alınacak her varlığın miktarı	page_size	True	integer	Alınacak her sayfanın boyutu. Değerler alırken bu, sayfa parametresi tarafından yapılan sonraki sayfalara erişirken sayfa başına en büyük boyut olur.
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.

Döndürülenler

Name	Yol	Tür	Description
page	meta.page	integer	Varlıkların sayfası. Bu sayfadaki varlık miktarı page_size tarafından tanımlanır.
page_size	meta.page_size	integer	Bu sayfaya gelen varlık sayısı.
total_items	meta.total_items	integer	Sayfa boyutuna veya numarasına bakılmaksızın veritabanında kullanılabilir varlık sayısı. Diğer sayfaları görmek için istekteki sayfa numarasını değiştirin.
items	items	array of object	Metin İsteği'nden alınan grup varlıklarının listesi.
kimlik	items.id	integer	Grubun sayısal kimliği.
group_member_count	items.group_member_count	integer	Grubun üye sayısı.
is_keyword	items.is_keyword	boolean	Bu grup bir anahtar sözcük grubudur. Kullanıcı bir anahtar sözcük ayarladığında bu tür gruplar otomatik olarak oluşturulur. Kişiler kaydolduğunda otomatik olarak eklenir.
name	items.name	string	Bu grubun adı.
Notlar	items.notes	string	Bu gruptaki tüm notlar.
last_message_sent_utc	items.last_message_sent_utc	string	Bu grup için son grup iletisinin gönderildiği zaman damgası.

Tüm ödemeleri alır

İşlem Kimliği:

GetPayments

İptal edilen ve ödenen ödemeler de dahil olmak üzere tüm ödemeleri alır. Bunlar sorgu parametreleri kullanılarak filtrelenebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ödemenin başvuru dizesi	reference_number		string	Ödemeleri hızla bulmak için kullanılabilecek ödemeler oluşturulduğunda tanımlanan kullanıcı tanımlı kimlik. Başvuru numaraları benzersiz değildir; birçok ödeme aynı başvuruya sahip olabilir.
Ödeme telefon numarası	phone_number		string	Bu ödemenin gönderildiği kişinin telefon numarası.
Sıralama ölçütü	sort_type		string	Ödemeleri sıralamak için özellik. "amount", "contact", "date", "status" olabilir.
Sıralama yönü	sort_direction		string	Ödemeleri sıralama yönü. En büyük ve en küçük için "desc" veya en küçük ile en büyük arasında "asc" olabilir.
Alınacak numara sayfası	page	True	integer	Alınacak varlıkların sayfası. Değerler alırken, sayfa başına page_size tarafından tanımlanan maksimum boyut vardır. Sayfa son sayfadan büyükse boş bir dizi döndürülür.
Sayfa başına alınacak her varlığın miktarı	page_size	True	integer	Alınacak her sayfanın boyutu. Değerler alırken bu, sayfa parametresi tarafından yapılan sonraki sayfalara erişirken sayfa başına en büyük boyut olur.
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.

Döndürülenler

Name	Yol	Tür	Description
page	meta.page	integer	Varlıkların sayfası. Bu sayfadaki varlık miktarı page_size tarafından tanımlanır.
page_size	meta.page_size	integer	Bu sayfaya gelen varlık sayısı.
total_items	meta.total_items	integer	Sayfa boyutuna veya numarasına bakılmaksızın veritabanında kullanılabilir varlık sayısı. Diğer sayfaları görmek için istekteki sayfa numarasını değiştirin.
items	items	array of object	Metin İsteği'nden alınan ödeme varlıklarının listesi.
payment_id	items.payment_id	integer	Ödemenin sayısal kimliği.
request_date	items.request_date	string	Bu ödemenin ilk iletisinin gönderilmek üzere kuyruğa alındığı zaman damgası.
alıcı	items.recipient	string	Ödeme alıcısının adı. Kişinin telefon numarasıyla ilişkilendirilmiş bir adı yoksa bu null olabilir.
açıklama	items.description	string	Ödemenin açıklaması. Bu, kişiye gösterilmez. Yalnızca iç kullanıcılar tarafından ödemelerle ilgili bağlam için kullanılır.
customer_phone	items.customer_phone	string	Bu ödemenin gönderileceği kişinin telefon numarası.
amount_requested	items.amount_requested	float	Bu ödemenin talep ettiği dolar cinsinden tutar.
is_past_due	items.is_past_due	boolean	Bu ödemenin istek tarihini geçmiş olup olmadığı.
reminder_was_sent	items.reminder_was_sent	boolean	Bu ödeme için bir kısa mesaj anımsatıcısı gönderilip gönderilmediği.
transaction_status	items.transaction_status	string	İşlemin authvia içindeki durumu. Bu değer Bilinmiyor olarak başlar.
textrequest_payment_status	items.textrequest_payment_status	string	Metin İsteği'nde işlemin durumu. Bu, Metin İsteği uygulamasının ödemeler sayfasında gösterilen durumu temsil eder. Gönderildi olarak başlar.
reference_number	items.reference_number	string	Ödemeleri hızla bulmak için kullanılabilecek ödemeler oluşturulduğunda tanımlanan kullanıcı tanımlı kimlik. Başvuru numaraları benzersiz değildir; birçok ödeme aynı başvuruya sahip olabilir.

Tüm özel alanları alır

İşlem Kimliği:

GetCustomFields

Bu pano için tüm özel alanları alır. Özel alanlar panolar arasında benzersizdir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.

Döndürülenler

Name	Yol	Tür	Description
		array of object
kimlik	id	string	Alanın sayısal kimliği.
name	name	string	Özel alanın adı.

Verilen ad ve telefon numarasıyla yeni bir pano oluşturma

İşlem Kimliği:

CreateDashboard

Hesapta yeni bir pano oluşturur. Pano oluşturulduktan sonra yöneticilere değişiklik hakkında e-posta gönderilir ve kullanıcılar atamaya başlayabilir. Bu uç nokta sağlanan numaralar için bir pano oluşturabilir. GET /dashboards/provisioning kullanarak belirli bir alan kodunda sağlanan numaraları arayabilirsiniz. Telefon numarası zaten kullanılıyorsa, Hatalı İstek özel durumu oluşturulur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
name	name		string	Panonun adı.
phone	phone		string	Bu panoyla ilişkilendirilmiş metin numarası.

Döndürülenler

Name	Yol	Tür	Description
kimlik	id	integer	Panonun sayısal kimliği.
name	name	string	Panonun adı.
phone	phone	string	Bu panoyla ilişkilendirilmiş metin numarası.

Verilen kimlikle bir grubu güncelleştirir

İşlem Kimliği:

UpdateGroup

Grubun sayısal kimliğini kullanarak grubun adını güncelleştirir. Geçirilen grup kimliği yoksa, çağrı başarısız olur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Grubun kimliği	group_id	True	integer	Güncelleştirilecek grubun sayısal kimliği.
Grup adı	name		string	Grubun yeni adı.
Grup notu	notes		string	Grubu açıklayan kısa tümcecik. Kolaylık sağlamak için kullanılır.

Döndürülenler

Name	Yol	Tür	Description
kimlik	id	integer	Grubun sayısal kimliği.
group_member_count	group_member_count	integer	Grubun üye sayısı.
is_keyword	is_keyword	boolean	Bu grup bir anahtar sözcük grubudur. Kullanıcı bir anahtar sözcük ayarladığında bu tür gruplar otomatik olarak oluşturulur. Kişiler kaydolduğunda otomatik olarak eklenir.
name	name	string	Bu grubun adı.
Notlar	notes	string	Bu gruptaki tüm notlar.
last_message_sent_utc	last_message_sent_utc	string	Bu grup için son grup iletisinin gönderildiği zaman damgası.

Verilen telefon numarasını içeren kişiye ileti gönderme

İşlem Kimliği:

SendMessageByPhoneNumber

İleti gönderir (verilen telefon numarasının ileti geçmişi yoksa yeni bir konuşma başlatır).

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Telefon Numarası İletiye	phone_number	True	string	İleti gönderilecek kişinin telefon numarası.
İleti gövdesi	body		string	Gönderilecek iletinin içeriği.
Gönderenin adı	sender_name		string	İletiyi gönderenin adı. Bu, bu ileti alınırken TextRequest web uygulamasında ve api'sinde gösterilir.
İleti durumunun güncelleştirilme zamanları için geri arama URL'si	status_callback		string	Bu iletinin durumu teslim edilmemişten gönderildi (veya hata) durumuna her geçtiğinde web uygulamasının POST komutuyla isabet edecek URL'si.
Bu iletide bir tane varsa konum istekleri için geri arama URL'si	location_callback		string	Kullanıcı konumlarını gönderenle paylaşmayı onayladığında post komutuyla isabet etmek için konum geri arama URL'si. Bağlantıyı eklemek için ileti gövdesine [Konum İsteği] ekleyin. Konum istekleri için bu geri çağırma gerekli değildir, ancak API'ler için yararlı olabilir.
Bu ileti için MMS Medya ekleri	mms_media		array of string	Bu ileti için MMS Medya ekleri dizisi. Ekler/mms sonrası uç noktasından alınan url'ler olmalıdır (bu bağlayıcıya dahil değildir). Dış ek bağlantıları kabul edilmeyecektir.

Döndürülenler

Name	Yol	Tür	Description
message_id	message_id	string	İletinin kimliği. Bu değer her ileti için benzersizdir.
body	body	string	Bu iletinin içeriği.
message_direction	message_direction	string	R veya S olmak üzere tekil karakter, bu iletinin kişiden mi alındığını yoksa onlara mı gönderildiğini gösterir.
response_by_username	response_by_username	string	Bu kullanıcıya en son ileti gönderen Metin İsteği kullanıcısının kullanıcı adı.
message_timestamp_utc	message_timestamp_utc	string	İletinin Metin İsteği tarafından ne zaman gönderildiğine veya alındığına ilişkin zaman damgası.
delivery_status	delivery_status	string	Bu iletinin geçerli durumu. Bu 'gönderme', 'teslim', 'hata' veya 'gönder' olabilir.
delivery_error	delivery_error	string	Bu iletinin teslim edilememesi hatası. delivery_status 'error' değilse, bu değer null olur.
mms_media	mms_media	array of string	Bu iletinin eklerine işaret eden URL'lerin listesi. Tüm URL'ler metin isteği tarafından oluşturulan url'ler olacaktır.

Yeni grup oluşturur

İşlem Kimliği:

CreateGroup

Sağlanan ada sahip yeni bir grup oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Grup adı	name		string	Grubun yeni adı.
Grup notu	notes		string	Grubu açıklayan kısa tümcecik. Kolaylık sağlamak için kullanılır.

Döndürülenler

Name	Yol	Tür	Description
kimlik	id	integer	Grubun sayısal kimliği.
group_member_count	group_member_count	integer	Grubun üye sayısı.
is_keyword	is_keyword	boolean	Bu grup bir anahtar sözcük grubudur. Kullanıcı bir anahtar sözcük ayarladığında bu tür gruplar otomatik olarak oluşturulur. Kişiler kaydolduğunda otomatik olarak eklenir.
name	name	string	Bu grubun adı.
Notlar	notes	string	Bu gruptaki tüm notlar.
last_message_sent_utc	last_message_sent_utc	string	Bu grup için son grup iletisinin gönderildiği zaman damgası.

Yeni ödeme oluşturur

İşlem Kimliği:

CreatePayment

Sağlanan kişiye verilen iletiyle yeni bir ödeme oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Ödeme açıklaması	description		string	Ödemenin açıklaması. Açıklama kişiye gösterilmez ve yalnızca iç kullanıcılar tarafından ödemelerle ilgili bağlam için kullanılır.
Alıcı telefon numarası	customer_phone		string	Bu ödemenin gönderileceği kişinin telefon numarası.
Dolar cinsinden istenen tutar	amount_requested		float	Bu ödemenin talep ettiği dolar cinsinden tutar.
Ödeme iletisi metin gövdesi	message		string	Ödeme bağlantısıyla birlikte ilgili kişiye gönderilecek ileti metni.
Ödemenin başvuru dizesi	reference_number		string	Ödemeleri hızla bulmak için kullanılabilecek ödemeler oluşturulduğunda tanımlanan kullanıcı tanımlı kimlik. Başvuru numaraları benzersiz değildir; birçok ödeme aynı başvuruya sahip olabilir.

Döndürülenler

Name	Yol	Tür	Description
payment_id	payment_id	integer	Ödemenin sayısal kimliği.
request_date	request_date	string	Bu ödemenin ilk iletisinin gönderilmek üzere kuyruğa alındığı zaman damgası.
alıcı	recipient	string	Ödeme alıcısının adı. Kişinin telefon numarasıyla ilişkilendirilmiş bir adı yoksa bu null olabilir.
açıklama	description	string	Ödemenin açıklaması. Bu, kişiye gösterilmez. Yalnızca iç kullanıcılar tarafından ödemelerle ilgili bağlam için kullanılır.
customer_phone	customer_phone	string	Bu ödemenin gönderileceği kişinin telefon numarası.
amount_requested	amount_requested	float	Bu ödemenin talep ettiği dolar cinsinden tutar.
is_past_due	is_past_due	boolean	Bu ödemenin istek tarihini geçmiş olup olmadığı.
reminder_was_sent	reminder_was_sent	boolean	Bu ödeme için bir kısa mesaj anımsatıcısı gönderilip gönderilmediği.
transaction_status	transaction_status	string	İşlemin authvia içindeki durumu. Bu değer Bilinmiyor olarak başlar.
textrequest_payment_status	textrequest_payment_status	string	Metin İsteği'nde işlemin durumu. Bu, Metin İsteği uygulamasının ödemeler sayfasında gösterilen durumu temsil eder. Gönderildi olarak başlar.
reference_number	reference_number	string	Ödemeleri hızla bulmak için kullanılabilecek ödemeler oluşturulduğunda tanımlanan kullanıcı tanımlı kimlik. Başvuru numaraları benzersiz değildir; birçok ödeme aynı başvuruya sahip olabilir.

Ödemeyi ödendi olarak işaretleme

İşlem Kimliği:

MarkPaymentPaid

Bir ödemeyi "ödendi" olarak kapatır. Ödemenin ödeme isteği portalı dışında bir yolla ödendiği durumlarda bu uç noktayı kullanın. Bu işlem, ödemeyi kapatır ve ödeme tutarını istatistiklerinize ekler. Bu uç nokta, Metin İsteği aracılığıyla gönderilen payments-portal üzerinden ödenen ödemeler için gerekli değildir; otomatik olarak ödeme olarak işaretlenir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bu aramayı yapmak için panonun kimliği	dashboard_id	True	integer	Üzerinde çalışacak telefon numarası panosu. Tek bir hesapta müşteriler için farklı telefon hatlarını temsil eden çeşitli panolar olabilir.
Ödemenin kimliği	payment_id	True	integer	Güncelleştirilecek ödemenin sayısal kimliği.

Döndürülenler

Name	Yol	Tür	Description
payment_id	payment_id	integer	Ödemenin sayısal kimliği.
request_date	request_date	string	Bu ödemenin ilk iletisinin gönderilmek üzere kuyruğa alındığı zaman damgası.
alıcı	recipient	string	Ödeme alıcısının adı. Kişinin telefon numarasıyla ilişkilendirilmiş bir adı yoksa bu null olabilir.
açıklama	description	string	Ödemenin açıklaması. Bu, kişiye gösterilmez. Yalnızca iç kullanıcılar tarafından ödemelerle ilgili bağlam için kullanılır.
customer_phone	customer_phone	string	Bu ödemenin gönderileceği kişinin telefon numarası.
amount_requested	amount_requested	float	Bu ödemenin talep ettiği dolar cinsinden tutar.
is_past_due	is_past_due	boolean	Bu ödemenin istek tarihini geçmiş olup olmadığı.
reminder_was_sent	reminder_was_sent	boolean	Bu ödeme için bir kısa mesaj anımsatıcısı gönderilip gönderilmediği.
transaction_status	transaction_status	string	İşlemin authvia içindeki durumu. Bu değer Bilinmiyor olarak başlar.
textrequest_payment_status	textrequest_payment_status	string	Metin İsteği'nde işlemin durumu. Bu, Metin İsteği uygulamasının ödemeler sayfasında gösterilen durumu temsil eder. Gönderildi olarak başlar.
reference_number	reference_number	string	Ödemeleri hızla bulmak için kullanılabilecek ödemeler oluşturulduğunda tanımlanan kullanıcı tanımlı kimlik. Başvuru numaraları benzersiz değildir; birçok ödeme aynı başvuruya sahip olabilir.

Tetikleyiciler

Bir metin gönderildiğinde veya alındığında tetikler

Bir metin gönderildiğinde veya alındığında tetikler

Bir metin gönderildiğinde veya alındığında tetikler

İşlem Kimliği:

TextingWebhook

Bir metin gönderildiğinde veya alındığında tetikler

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Tetikleyicinin olayları dinleyeceği pano	dashboard_id	True	string	Tetikleyici eklenecek panonun kimliği
etkinlik	event	True	string	etkinlik

Döndürülenler

Name	Yol	Tür	Description
İleti Benzersiz Kimliği	messageUniqueIdentifier	string	messageUniqueIdentifier
Hesap Kimliği	account.id	integer	kimlik
Konuşma Kimliği	yourPhoneNumber.id	integer	kimlik
Pano Adı	yourPhoneNumber.description	string	açıklama
Pano Telefon Numarası	yourPhoneNumber.phoneNumber	string	telefon numarası
Pano Kimliği	conversation.id	integer	kimlik
date	conversation.date	string	date
İlgili Kişi Telefon Numarası	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
message	conversation.message	string	message
numSegments	conversation.numSegments	integer	numSegments
statü	conversation.status	string	statü
Tarafından Talep Edilen Konuşma	conversation.claimedBy	string	claimedBy
Kişi Görünen Adı	conversation.consumerFriendlyName	string	consumerFriendlyName

Tanımlar

String

Bu, 'string' temel veri türüdür.