Biz 사용자 그룹별 Announcement 전송
등록된 Biz 사용자의 그룹 토큰을 기준으로, Biz 사용자가 수신 지정한 디바이스에 Announcement API를 발송 할 수 있습니다.

1. URL

1
[POST] https://biz-api.sktnugu.com/api/v1/enrolledUser/group/{groupApiToken}/announcement?callBack={callBackUrl}
Copied!

2. Request

2.1 Body

1
{
2
"playServiceId": "XXX",
3
"tts" {
4
"text": "발송 내용",
5
"speed": "100",
6
"pause1": "600",
7
"pause2": "300"
8
},
9
"display" : {
10
"type": "imageText2",
11
"title": "타이틀",
12
"header": "헤더",
13
"body": "본문",
14
"footer": "부가설명",
15
"image": "http://imageUrl"
16
}
17
}
Copied!

2.2 설명

이름
유형
속성
필수
설명
Publisher-Token
Header
string
Y
퍼블리셔가 보유한 토큰
groupApiToken
path
string
Y
발송할 그룹의 API 토큰
playServiceId
body
string
Y
발송 대상 play 대상 play의 합성음, TTS Domain을 기준으로 SKML을 생성
tts
body
object
TTS를 구성하는 객체
tts.text
body
string
Y
발화문장 발화문장, Display 객체 중 반드시 1개 이상은 존재해야 한다.
tts.speed
body
string
발화속도 85, 90... 120까지의 5단위 값 기본값은 100
tts.pause1
body
string
문장 사이 묵음 구간 길이 300, 400... 900까지의 100단위 값 기본값은 600
tts.pause2
body
string
100, 200... 500까지의 100단위 값 기본값은 300
display
body
object
Y
Display 객체 발화문장, Display 객체 중 반드시 1개 이상은 존재해야 한다.
display.type
body
string
Y
사용할 Display Template FullText1, ImageText2중 하나
display.title
body
string
Y
화면 타이틀
display.header
body
string
Y
본문 제목
display.body
body
string
Y
본문 내용
display.footer
body
string
본문 부가 설명
display.image
body
string
이미지 ImageText Type에서 이미지가 없을 경우, 디폴트 이미지 노출

3. Response

3.1 HTTP Status

HTTP Status
errorCode
설명
202
정상 요청
403
퍼블리셔 API Token이 유효하지 않거나, 유효하지 않은 자원에 접근할 경우 리턴
404
발송 요청한 그룹이 존재하지 않을 때 응답값
400
V1ANN001
body 값을 파싱할 수 없음
400
V1ANN002
playServiceId 없음
400
V1ANN101
tts, display 객체가 모두 존재하지 않음
400
V1ANN102
tts.text 없음
400
V1ANN103
tts.speed 값이 잘못됨
400
V1ANN104
tts.pause1 값이 잘못됨
400
V1ANN105
tts.pause2 값이 잘못됨
400
V1ANN201
display.type 값이 잘못됨
400
V1ANN202
display.title 값이 없음
400
V1ANN203
display.header 값이 없음
400
V1ANN204
display.body 값이 없음

3.2 Body

  • callback URL을 입력했을 경우에만 전달받음
1
{
2
"users": [
3
{
4
"id": "XXX",
5
"name": "XXX",
6
"email": "XXX",
7
"resultCode": "OK",
8
"deviceResults": [
9
{"code": "XXX"}
10
]
11
}
12
]
13
}
Copied!

3.3 설명

이름
속성
설명
users
array of object
발송 요청 그룹내 사용자들의 발송 결과
users[].id
string
발송 대상 Biz 사용자 ID
users[].name
string
발송 대상 Biz 사용자 이름
users[].email
string
발송 대상 Biz 사용자 이메일
users[].resultCode
enum
발송 결과
OK : 발송 대상 기기 모두 성공
SOME_OK : 발송 대상 기기 일부 성공
FAIL : 발송 대상 기기 모두 실패
NOT_AGREE : API 수신 거부
NO_DEVICE : API 수신 허용 기기 없음
users[].deviceResults
array of object
기기별 응답값
users[].deviceResults[].code
enum
기기별 발송 결과
NOT_CONNECTED : 사용자에 연결되지 않은 기기
TIMEOUT : 기기와의 연결 실패
CONNECT_ERROR : 기기가 꺼져 있거나, 네트워크에 문제가 있음
\
Last modified 15d ago