앱푸시 단건발송

특정 앱이 설치된 기기 중 특정 사용자에게 앱 푸시를 전송하는 단건 발송 API

개요

앱푸시 단건 발송은 특정 대상, 즉 식별자가 일치하는 단일 대상에게 메세지를 보내는 방법입니다.

해당 식별자는 사용자를 구분할 수 있다면 어떤 것이든 가능하며, SDK 설치 및 앱 실행시에 삽입하는 디바이스 등록 코드에서 함께 등록 가능합니다.

앱 식별자 등록

Android

@Override
public void onComplete(String code, String message, JSONObject jsonObject) {
    if(code.equals("200") || code.equals("201")) {
        // 디바이스 최초 등록시 해당 코드 리턴 후 태그 등록
        FingerPushManager.getInstance(Context).setIdentity("IDENTITY", new NetworkUtility.ObjectListener() {
            @Override
            public void onComplete(String code, String message, JSONObject jsonObject) {                         
            }
            
            @Override
            public void onError(String code, String message,) {
            }
        });
    }
}

IOS

#pragma mark - push notification
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    /*핑거푸시에 기기등록*/
    [fingerManager registerUserWithBlock:deviceToken :^(NSString *posts, NSError *error) {
        NSLog(@"토큰 : %@",self->fingerManager.getToken);
        NSLog(@"토큰idx : %@",self->fingerManager.getDeviceIdx);
        NSLog(@"기기등록 posts : %@ / error : %@",posts,error);
    }];
}

앱푸시 스탠다드 단건발송 API

캐릭터 인코딩은 UTF-8 을 기본으로 하므로, UTF-8 유니코드 특수 문자에 들어가는 이모티콘을 사용할 수 있습니다.

앱푸시 스탠다드 일괄발송 API

POST https://9cg6ws1y9p.apigw.ntruss.com/app-push/v1_0/api/notify/one

Headers

Name

Type

Description

Authorization*

string

사용자ID;secret_key

Request Body

Name

Type

Description

appkey*

string

fnm

string

첨부 이미지 링크

(도메인을 포함한 전체 경로 입력)

256 Byte 제한

link

string

Push를 눌렀을 때 연결되는 링크

256 Byte 제한

isi

string

Y: IOS 기기 대상 발송(default)

N: IOS 기기를 전송 대상에서 제외

(해당 값이 빈 상태로 서버로 전달될 경우, 기본 값인 Y로 처리)

isa

string

Y: 안드로이드 기기 대상 발송(default)

N: 안드로이드 기기를 전송 대상에서 제외

(해당 값이 빈 상태로 서버로 전달될 경우, 기본 값인 Y로 처리)

msg*

string

보낼 Push 메시지(1000 Byte 제한)

customerkey*

string

appsecret*

string

etiquette_stime

number

에티켓 적용 시작시간 EX) 24(오전 0시)

(default: 21(오후 9시))

isetiquette

string

에티켓 시간 적용 여부

Y: 적용(default)

N: 적용 안함

fcolor

string

폰트 색상 EX) #000000

bgcolor

string

배경색 EX) #FFFFFF

title

string

Push 메세지 제목

100 Byte 제한

and_priority

string

안드로이드용 메시지 우선순위

H: 높음

M: 중간(default)

etiquette_etime

number

에티켓 적용 종료시간 EX) 16(오후 4시)

(default: 8(오전 8시))

optagree

string

0000: 광고 수신 동의 여부에 관계없이 푸시 수신자 모두에게 발송(default)

1000: 광고 수신 동의한 디바이스에만 메시지 발송

identity*

string

Push를 보낼 대상의 식별자

Response Body

{
    "result": "200",
    "msgIdx": "7wz6Ph56nwmAQS1rZ011",
    "processCode": "20003",
    "message": "정상 처리되었습니다. "
}

키

타입

설명

string

결과 코드

message

string

결과 메시지

msgIdx

string

등록된 메시지 번호. 결과 조회 시 사용

EX) DEF_40213134

string

메세지 처리 단계

Result Code 유형

result

설명

200

정상 처리 됨

4031

유효하지 않은 appkey 혹은 appsecret

4032

서비스 이용 권한이 없음

4040

존재하지 않는 식별자

500

서버 에러

503

필수 값이 누락됨

504

발송 대상 처리 중 에러

505

메세지 허용 byte 수 초과

processCode 유형

processCode

설명

20001

메세지 등록 정상 처리

20002

발송 대상자 등록 정상 처리

20003

Push 메세지 등록 완료

Was this helpful?

앱푸시 단건발송

특정 앱이 설치된 기기 중 특정 사용자에게 앱 푸시를 전송하는 단건 발송 API

개요

앱푸시 단건 발송은 특정 대상, 즉 식별자가 일치하는 단일 대상에게 메세지를 보내는 방법입니다.

해당 식별자는 사용자를 구분할 수 있다면 어떤 것이든 가능하며, SDK 설치 및 앱 실행시에 삽입하는 디바이스 등록 코드에서 함께 등록 가능합니다.

앱 식별자 등록

Android

@Override
public void onComplete(String code, String message, JSONObject jsonObject) {
    if(code.equals("200") || code.equals("201")) {
        // 디바이스 최초 등록시 해당 코드 리턴 후 태그 등록
        FingerPushManager.getInstance(Context).setIdentity("IDENTITY", new NetworkUtility.ObjectListener() {
            @Override
            public void onComplete(String code, String message, JSONObject jsonObject) {                         
            }
            
            @Override
            public void onError(String code, String message,) {
            }
        });
    }
}

IOS

#pragma mark - push notification
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    /*핑거푸시에 기기등록*/
    [fingerManager registerUserWithBlock:deviceToken :^(NSString *posts, NSError *error) {
        NSLog(@"토큰 : %@",self->fingerManager.getToken);
        NSLog(@"토큰idx : %@",self->fingerManager.getDeviceIdx);
        NSLog(@"기기등록 posts : %@ / error : %@",posts,error);
    }];
}

앱푸시 스탠다드 단건발송 API

캐릭터 인코딩은 UTF-8 을 기본으로 하므로, UTF-8 유니코드 특수 문자에 들어가는 이모티콘을 사용할 수 있습니다.

앱푸시 스탠다드 일괄발송 API

POST https://9cg6ws1y9p.apigw.ntruss.com/app-push/v1_0/api/notify/one

Headers

Name

Type

Description

Authorization*

string

사용자ID;secret_key

Request Body

Name

Type

Description

appkey*

string

Application key ()

fnm

string

첨부 이미지 링크

(도메인을 포함한 전체 경로 입력)

256 Byte 제한

link

string

Push를 눌렀을 때 연결되는 링크

256 Byte 제한

isi

string

Y: IOS 기기 대상 발송(default)

N: IOS 기기를 전송 대상에서 제외

(해당 값이 빈 상태로 서버로 전달될 경우, 기본 값인 Y로 처리)

isa

string

Y: 안드로이드 기기 대상 발송(default)

N: 안드로이드 기기를 전송 대상에서 제외

(해당 값이 빈 상태로 서버로 전달될 경우, 기본 값인 Y로 처리)

msg*

string

보낼 Push 메시지(1000 Byte 제한)

customerkey*

string

Customer key ()

appsecret*

string

Application Secret ()

etiquette_stime

number

에티켓 적용 시작시간 EX) 24(오전 0시)

(default: 21(오후 9시))

isetiquette

string

에티켓 시간 적용 여부

Y: 적용(default)

N: 적용 안함

fcolor

string

폰트 색상 EX) #000000

bgcolor

string

배경색 EX) #FFFFFF

title

string

Push 메세지 제목

100 Byte 제한

and_priority

string

안드로이드용 메시지 우선순위

H: 높음

M: 중간(default)

etiquette_etime

number

에티켓 적용 종료시간 EX) 16(오후 4시)

(default: 8(오전 8시))

optagree

string

0000: 광고 수신 동의 여부에 관계없이 푸시 수신자 모두에게 발송(default)

1000: 광고 수신 동의한 디바이스에만 메시지 발송

identity*

string

Push를 보낼 대상의 식별자

Response Body

{
    "result": "200",
    "msgIdx": "7wz6Ph56nwmAQS1rZ011",
    "processCode": "20003",
    "message": "정상 처리되었습니다. "
}

키

타입

설명

string

결과 코드

message

string

결과 메시지

msgIdx

string

등록된 메시지 번호. 결과 조회 시 사용

EX) DEF_40213134

string

메세지 처리 단계

Result Code 유형

result

설명

200

정상 처리 됨

4031

유효하지 않은 appkey 혹은 appsecret

4032

서비스 이용 권한이 없음

4040

존재하지 않는 식별자

500

서버 에러

503

필수 값이 누락됨

504

발송 대상 처리 중 에러

505

메세지 허용 byte 수 초과

processCode 유형

processCode

설명

20001

메세지 등록 정상 처리

20002

발송 대상자 등록 정상 처리

20003

Push 메세지 등록 완료

Was this helpful?