SMS-ek — sms

Művelet	Mit tesz	Jog
GET /sms/list	SMS-ek, szűrőkkel	sms:read
GET /sms/get	egy SMS	sms:read
GET /sms/schema	a mezők leírása	sms:read
POST /sms/send	SMS küldése	sms:send

A mezők

Mező	Régi	Típus		Listában	Leírás
id	smsid	integer	csak olvasható	✓	belső azonosító
direction	sms_direction	string	csak olvasható	✓	in — bejövő, out — kimenő
status	sms_state	string	csak olvasható	✓	az állapot — lent
statusDetail	log_notes	string	csak olvasható	✓	a küldés eredményének részlete, például a hiba oka
phoneNumber	to_phone	string(20)	csak olvasható	✓	a partner száma: a kimenő SMS címzettje, a bejövő feladója
ccNumber	callcenter_phone	string(20)	csak olvasható	✓	a saját oldal száma, vagy a küldő neve
text	sms_message	string	csak olvasható	✓	a szöveg
projectId	prid	integer	csak olvasható	✓	a projekt belső azonosítója
projectCode	prcode	string	csak olvasható	✓	a projekt külső azonosítója
projectName	—	string	csak olvasható	✓	a projekt neve
accountId	—	integer	csak olvasható	✓	az SMS-fiók belső azonosítója
accountName	—	string	csak olvasható	✓	a fiók neve
listId	lsid	integer	csak olvasható	✓	az ügyfél listája
listCode	lscode	string	csak olvasható	✓	a lista külső azonosítója
listName	list_name	string	csak olvasható	✓	a lista neve
listItemId	listitem_num	integer	csak olvasható	✓	az ügyfél listatétele
listItemCode	—	string	csak olvasható	✓	a listatétel külső azonosítója
listItemName	spec_header1_data	string	csak olvasható	✓	az ügyfél a lista első fejléc-oszlopából — listánként más adat
contactNo	—	integer	csak olvasható	✓	a listatétel kontaktjának sorszáma
contactName	contact_name	string	csak olvasható	✓	a kontakt neve
interviewId	interviewid	integer	csak olvasható	✓	a hívás rekordja, amelyikhez az SMS tartozik
interviewCode	—	string	csak olvasható	✓	az interjú kódja
userId	userid	integer	csak olvasható	✓	aki az SMS-t felvette, vagy utoljára kezelte; üres, ha nem felhasználó (a rendszer vagy egy API-kulcs)
userCode	user_code	string	csak olvasható	✓	a felhasználó külső azonosítója
userName	—	string	csak olvasható	✓	a felhasználó neve
userExtCode	—	string	csak olvasható	✓	a felhasználó egyéb kódja
createdAt	—	string	csak olvasható	✓	az SMS felvételének ideje
scheduledAt	scheduled_time	string	csak olvasható	✓	a kimenő SMS tervezett küldése
sentAt	send_time	string	csak olvasható	✓	a küldés ideje; a bejövő SMS-nél az érkezés
updatedAt	—	string	csak olvasható	✓	az utolsó módosítás ideje

Az állapot: a bejövőn new · closed; a kimenőn scheduled (küldésre vár) · sending · sent · delivered · undelivered (a szolgáltató nem tudta kézbesíteni) · failed (nem ment ki) · cancelled (a küldést visszavonták).

GET /sms/list SMS-ek

Az SMS-ek, lapozva (A lapozás). A szűrők mind elhagyhatók:

Paraméter	Régi	Típus	Leírás
projectId · projectCode	prid · prcode		a projekt SMS-ei
direction	direction	string	in vagy out
status	—	string	egy állapot
userId · userCode	—		a felhasználó SMS-ei
listId · listCode	lsid · lscode		a lista ügyfeleinek SMS-ei
listItemId	—	integer	egy ügyfél SMS-ei
phoneNumber	phone	string	a partner száma; a 06-tal, a +36-tal és a 0036-tal kezdődő alakja is talál
sentSince · sentUntil	start_date · end_date	string	a küldés ideje — a még ki nem ment SMS-nél a tervezett idő — ettől, eddig

Válasz 200application/json

{
  "sms": [
    {
      "id": 7310,
      "direction": "out",
      "status": "delivered",
      "statusDetail": null,
      "phoneNumber": "36300000001",
      "ccNumber": "DemoKft",
      "text": "Rendelése holnap érkezik.",
      "projectId": 12,
      "projectCode": "SUPPORT",
      "projectName": "Ügyfélszolgálat",
      "accountId": 2,
      "accountName": "SMS szolgáltató",
      "listId": 3,
      "listCode": "OKT-2026",
      "listName": "Októberi lista",
      "listItemId": 884512,
      "listItemCode": "C-20931",
      "listItemName": "Szabó Péter",
      "contactNo": 1,
      "contactName": "Szabó Péter",
      "interviewId": null,
      "interviewCode": null,
      "userId": null,
      "userCode": null,
      "userName": null,
      "userExtCode": null,
      "createdAt": "2026-10-20T09:12:04+02:00",
      "scheduledAt": "2026-10-20T09:12:04+02:00",
      "sentAt": "2026-10-20T09:12:10+02:00",
      "updatedAt": "2026-10-20T09:12:31+02:00"
    }
  ],
  "hasMore": false
}

curl "$BASE/sms/list?direction=in&status=new" -H "X-API-Key: $API_KEY"

GET /sms/get Egy SMS

Az SMS a lista mezőivel.

curl "$BASE/sms/get?id=7310" -H "X-API-Key: $API_KEY"

GET /sms/schema A mezők leírása

A válasz alakja: A mezők leírása.

curl "$BASE/sms/schema" -H "X-API-Key: $API_KEY"

POST /sms/send SMS küldése

Az SMS a projekt SMS-fiókjáról megy. A válasz 202: az SMS küldésre vár, a get mutatja, hova jutott — a Location fejléc oda mutat. Ugyanaz a szöveg ugyanarra a számra 10 percen belül csak egyszer megy ki: a másodiké failed, az oka a statusDetail-ben.

Mező	Régi	Típus		Leírás
projectId · projectCode	prid · prcode		kötelező	a projekt
accountId	cfid	integer		az SMS-fiók, a projekthez választható fiókok közül; elhagyva a projekt fiókja — ha a projekthez több is választható, kötelező
phoneNumber	to_phone	string	kötelező, ha nincs kontakt	a címzett száma, országhívóval; a 06 helyén 36, a 20, 30, 31, 50, 70 kezdetű 9 jegyű szám elé 36 kerül
text	sms_message	string	kötelező	a szöveg, legfeljebb három SMS-rész
gsm7	—	boolean		true: a szöveg ékezetek nélkül, az alap SMS-karakterkészletre alakítva — így egy részbe több fér
sendAt	send_time	string		a küldés ideje, legfeljebb egy évre előre; elhagyva most
listItemId, vagy listId / listCode és listItemCode	listitem_num · lsid · lscode · extcode			az ügyfél listatétele, a projekt egyik listájából vagy telefonkönyvéből
contactNo	contact_num	integer		a listatétel kontaktja; a phoneNumber elhagyva a kontakt száma — ha mindkettő jön, egyezniük kell

Kérésapplication/json

{
  "projectCode": "SUPPORT",
  "phoneNumber": "36300000001",
  "text": "Rendelése holnap érkezik.",
  "listItemId": 884512,
  "contactNo": 1
}

Válasz 202application/json

{ "id": 7311 }

HTTP	code	Mikor
422	VALIDATION_FAILED	hibás szám (INVALID_PHONE) · a fiókkal csak magyar mobilszámra küldhető (HUNGARIAN_MOBILE_ONLY) · tiltólistás szám (BLOCKED_NUMBER) · üres vagy túl hosszú szöveg (EMPTY_TEXT, TOO_MANY_PARTS) · elmúlt vagy túl késői küldési idő (SEND_TIME_PAST, SEND_TIME_TOO_LATE)
422	VALIDATION_FAILED	a projektnek nincs SMS-fiókja (PROJECT_NO_ACCOUNT) · több fiók választható, és nincs accountId (ACCOUNT_REQUIRED) · a fiók nem választható a projekthez (ACCOUNT_NOT_ALLOWED)
422	VALIDATION_FAILED	a listatétel nem a projekté (ITEM_NOT_IN_PROJECT) · a kontakt tiltott (CONTACT_DISABLED) · a kontaktnak nincs száma (CONTACT_NO_PHONE) · a szám nem a kontakté (PHONE_NOT_CONTACTS)

curl "$BASE/sms/send" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
  -d '{"projectCode": "SUPPORT", "phoneNumber": "36300000001", "text": "Rendelése holnap érkezik."}'

A régi API-ból

Cím	Kérés	Válasz	Működés
sms/list → GET /sms/list	a message nincs: a szöveg mindig jön · phone → phoneNumber · a direction szóval	az irány és az állapot szóval	—
sms/get → GET /sms/get	smsid → id	mint a listában	—
sms/new → POST /sms/send	a cfid elhagyható: alapból a projekt fiókja · a to_phone elhagyható, ha a kontakt adott	smsid → id	a szöveg legfeljebb három SMS-rész
—	—	—	csak az újban: sms/schema